Skip to content

docs(#247): improve MCP configuration examples#248

Merged
drillan merged 2 commits into
mainfrom
docs/247-improve-mcp-configuration-examples
Jan 15, 2026
Merged

docs(#247): improve MCP configuration examples#248
drillan merged 2 commits into
mainfrom
docs/247-improve-mcp-configuration-examples

Conversation

@drillan

@drillan drillan commented Jan 15, 2026

Copy link
Copy Markdown
Owner

Summary

  • インストール方法(パッケージ vs 開発用)に応じた cwd 設定の説明を追加
  • 複数のMCPクライアント向け設定例を追加(Claude Code, Claude Desktop, VS Code拡張, Cursor, Windsurf)
  • クライアント別設定ファイル一覧表を追加
  • README.md と docs/quickstart.md の両方を更新

Test plan

  • READMEのマークダウンが正しくレンダリングされることを確認
  • docs/quickstart.md のマークダウンが正しくレンダリングされることを確認
  • 各設定例のJSONが構文的に正しいことを確認

Closes #247

🤖 Generated with Claude Code

- Add installation method-specific cwd guidance (package vs development)
- Add configuration examples for multiple MCP clients:
  - Claude Code (~/.claude.json, .mcp.json)
  - Claude Desktop
  - VS Code extensions (Copilot Chat, Cline, Continue)
  - Cursor
  - Windsurf
- Add summary table of config file locations per client
- Update both README.md and docs/quickstart.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@drillan

drillan commented Jan 15, 2026

Copy link
Copy Markdown
Owner Author

PR Review Summary

✅ Critical Issues (0件)

Critical Issueは検出されませんでした。

⚠️ Important Issues (1件)

DRY原則違反 - README.mdとquickstart.mdの設定セクションがほぼ完全に重複

関連規則: Constitution Article 7 (DRY Principle)

README.mdとdocs/quickstart.mdの「Configuration」/「設定」セクションは、ほぼ完全に同一の内容(約120行)が重複しています。

重複内容:

  • インストール方法別の設定説明(パッケージ vs 開発用)
  • MCPクライアント別の設定ファイル一覧表
  • 5つのクライアント設定例(Claude Code, Claude Desktop, VS Code, Cursor, Windsurf)のJSON設定ブロック

推奨修正案:

  1. 設定の詳細は docs/quickstart.md または専用の docs/configuration.md に集約する
  2. README.mdからは詳細セクションへのリンクを貼り、最小限の例(1つのJSON設定例)のみ記載する

例:

## Configuration

MCPクライアントの設定ファイルに以下を追加します。詳細は[クイックスタートガイド](docs/quickstart.md#設定)を参照してください。

### 基本設定

```json
{
  "mcpServers": {
    "note-mcp": {
      "command": "uv",
      "args": ["run", "python", "-m", "note_mcp"],
      "cwd": "/path/to/note-mcp"
    }
  }
}

各MCPクライアント(Claude Code, Claude Desktop, VS Code, Cursor, Windsurf)の設定ファイルの場所と詳細は設定ガイドを参照してください。


### ✅ 技術的な正確性

| 項目 | 結果 |
|------|------|
| JSON構文 | 全て正しい |
| 設定ファイルパス | 正確 |
| クライアント別設定キー | 正しい(VS Codeは `servers`、他は `mcpServers`) |
| 両ファイル間の一貫性 | 整合している |

### 📝 Suggestions

- 将来のメンテナンス性を考慮し、設定変更時に2箇所を更新する必要がある現状の改善を検討してください

### 💡 Strengths

- 各MCPクライアント向けの設定例が網羅的に追加された
- インストール方法による `cwd` 設定の違いが明確に説明された
- 設定ファイル一覧表が見やすくまとめられた

---

🤖 *Reviewed by Claude Code*

- Consolidate detailed MCP client configuration in docs/quickstart.md
- Replace README.md Configuration section with basic example + links
- Remove ~95 lines of duplicated content

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@drillan

drillan commented Jan 15, 2026

Copy link
Copy Markdown
Owner Author

Code Review Response

Addressed

  • DRY原則違反の修正: README.mdのConfigurationセクションを簡素化
    • 詳細な設定例をdocs/quickstart.mdに集約(Single Source of Truth)
    • README.mdには基本設定例1つ + quickstart.mdへのリンクを配置
    • 約95行の重複コンテンツを削除

技術的詳細

  • インストール方法別の設定説明 → quickstart.mdへのリンク
  • MCPクライアント別設定ファイル一覧 → quickstart.mdへのリンク
  • 5つのクライアント設定例 → 基本例1つに集約(詳細はquickstart.mdを参照)

Commit: 07d650f

🤖 Addressed by Claude Code

@drillan drillan merged commit 44725e3 into main Jan 15, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: improve MCP configuration examples in README

1 participant