Skip to content

Commit 923ccb1

Browse files
yunbowclaude
andcommitted
fix(guidelines): markdownlint エラーを修正
- security.md: `-` リストを `*` に統一、空行を追加 (MD004/MD032) - mcp-server.md: コードブロックに言語指定を追加 (MD040) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 9806a94 commit 923ccb1

2 files changed

Lines changed: 15 additions & 14 deletions

File tree

03_guidelines/common/security.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -616,10 +616,11 @@ function verifyToolDefinition(tool: ToolDefinition, expectedHash: string): void
616616
```
617617

618618
**Mitigations:**
619-
- Pin external MCP server / plugin versions and verify via hash/checksum
620-
- Validate that tool `description` fields do not contain instruction-like patterns (`"always"`, `"ignore previous"`, `"secretly"`, etc.)
621-
- Never grant AI tools more permissions than required (principle of least privilege, Section 1)
622-
- Log all tool invocations with parameters; alert on unexpected file access or external network calls
619+
620+
* Pin external MCP server / plugin versions and verify via hash/checksum
621+
* Validate that tool `description` fields do not contain instruction-like patterns (`"always"`, `"ignore previous"`, `"secretly"`, etc.)
622+
* Never grant AI tools more permissions than required (principle of least privilege, Section 1)
623+
* Log all tool invocations with parameters; alert on unexpected file access or external network calls
623624

624625
---
625626

@@ -643,18 +644,18 @@ function redactSecrets(text: string): string {
643644
}
644645
```
645646

646-
- Never include API keys, DB credentials, or PII in prompts, system messages, or tool response content
647-
- Apply the same redact rules as server-side logging (Section 9 / common/logging.md PII Redaction)
647+
* Never include API keys, DB credentials, or PII in prompts, system messages, or tool response content
648+
* Apply the same redact rules as server-side logging (Section 9 / common/logging.md PII Redaction)
648649

649650
---
650651

651652
### 13.4 Dependency Pinning for AI Packages
652653

653654
AI / MCP related packages (e.g., `@modelcontextprotocol/sdk`, `mcp-remote`, AI SDK wrappers) have a history of rapidly-introduced CVEs.
654655

655-
- Pin exact versions in `package.json` for all AI-related packages
656-
- Run `npm audit` / Dependabot on every PR (same SLA as Section 10)
657-
- For `mcp-remote` specifically: CVE-2025-6514 (RCE via unsanitized OAuth metadata) — upgrade to the patched version immediately if used
656+
* Pin exact versions in `package.json` for all AI-related packages
657+
* Run `npm audit` / Dependabot on every PR (same SLA as Section 10)
658+
* For `mcp-remote` specifically: CVE-2025-6514 (RCE via unsanitized OAuth metadata) — upgrade to the patched version immediately if used
658659

659660
---
660661

03_guidelines/frameworks/nodejs-cli/mcp-server.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ const server = new Server(
7575

7676
Tool names map to an action the AI needs to perform. Use a **verb** that describes the outcome; parameters carry the object and modifiers.
7777

78-
```
78+
```text
7979
✅ analyze_dimension(dimension: "business" | "ux") — one tool, one verb
8080
❌ analyze_business / analyze_ux — same verb, proliferates tools
8181
```
@@ -148,7 +148,7 @@ Tool descriptions are **instruction documents for AI agents**, not human help te
148148

149149
### 3.1 Five Required Elements
150150

151-
```
151+
```text
152152
1. What it does — first sentence, most important
153153
2. When to use it — its place in the workflow
154154
3. What it returns — key fields in the response
@@ -283,7 +283,7 @@ return toolResult(
283283

284284
For AI-delegated analysis, split the tool into two phases: one that returns the prompt+data, and one that stores the AI's result.
285285

286-
```
286+
```text
287287
AI → tool(phase="get-prompt") → data + prompt template returned
288288
AI → (runs inference)
289289
AI → displays result to user
@@ -353,7 +353,7 @@ Include a `next_step` hint in responses to guide the AI through sequential workf
353353

354354
Design multi-step workflows for sequential execution. Parallel execution hides intermediate results from the user and prevents the AI from using earlier results in later steps.
355355

356-
```
356+
```text
357357
❌ Promise.all([analyze_business(), analyze_ux()])
358358
→ user sees nothing until all complete; no cross-referencing possible
359359
@@ -455,7 +455,7 @@ npx @modelcontextprotocol/inspector node dist/mcp/index.js
455455

456456
When adding a tool, complete every item before merging:
457457

458-
```
458+
```text
459459
□ Naming: verb-first, namespaced (Section 2.1)
460460
□ inputSchema: flat + enum for all choices (Section 2.2, 2.3)
461461
□ annotations: readOnlyHint, idempotentHint, openWorldHint set (Section 2.4)

0 commit comments

Comments
 (0)