From 552c1c93c56c1c45ecee522303b842c9e43829a5 Mon Sep 17 00:00:00 2001 From: driller Date: Thu, 15 Jan 2026 10:09:26 +0900 Subject: [PATCH 1/2] docs(#247): improve MCP configuration examples - 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 --- README.md | 113 ++++++++++++++++++++++++++++++++++++++++++++- docs/quickstart.md | 101 ++++++++++++++++++++++++++++++++++++++-- 2 files changed, 210 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index db6a80d..08af39b 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,120 @@ uv run playwright install chromium ## Configuration +MCPクライアントの設定ファイルに以下を追加します。`cwd` はインストール方法によって異なります。 + +### インストール方法別の設定 + +#### パッケージインストールの場合 + +`uv pip install git+...` でインストールした場合、`cwd` は **note-mcpを使用するプロジェクトのディレクトリ** を指定します： + +```json +{ + "mcpServers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/your-project" + } + } +} +``` + +#### 開発用インストールの場合 + +`git clone` + `uv sync` でインストールした場合、`cwd` は **クローンしたリポジトリのディレクトリ** を指定します： + +```json +{ + "mcpServers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/note-mcp" + } + } +} +``` + +### MCPクライアント別の設定ファイル + +| クライアント | 設定ファイル | +|-------------|-------------| +| Claude Code | `~/.claude.json` または `.mcp.json` | +| Claude Desktop | `~/.config/claude-desktop/config.json` (macOS/Linux) | +| | `%APPDATA%\claude-desktop\config.json` (Windows) | +| VS Code (Copilot Chat, Cline, Continue等) | `.vscode/mcp.json` | +| Cursor | `.cursor/mcp.json` | +| Windsurf | `~/.codeium/windsurf/mcp_config.json` | + +### Claude Code + +グローバル設定（`~/.claude.json`）またはプロジェクト設定（`.mcp.json`）に追加： + +```json +{ + "mcpServers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/note-mcp" + } + } +} +``` + ### Claude Desktop -`~/.config/claude-desktop/config.json`（macOS/Linux）または `%APPDATA%\claude-desktop\config.json`（Windows）に以下を追加: +`~/.config/claude-desktop/config.json`（macOS/Linux）または `%APPDATA%\claude-desktop\config.json`（Windows）に追加： + +```json +{ + "mcpServers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/note-mcp" + } + } +} +``` + +### VS Code拡張 (Copilot Chat, Cline, Continue等) + +`.vscode/mcp.json` に追加： + +```json +{ + "servers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/note-mcp" + } + } +} +``` + +### Cursor + +`.cursor/mcp.json` に追加： + +```json +{ + "mcpServers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/note-mcp" + } + } +} +``` + +### Windsurf + +`~/.codeium/windsurf/mcp_config.json` に追加： ```json { diff --git a/docs/quickstart.md b/docs/quickstart.md index b978c26..6fe05ae 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -30,9 +30,29 @@ uv run playwright install chromium ## 設定 -### Claude Desktop +MCPクライアントの設定ファイルに以下を追加します。`cwd` はインストール方法によって異なります。 + +### インストール方法別の設定 + +#### パッケージインストールの場合 -`~/.config/claude-desktop/config.json`（macOS/Linux）または `%APPDATA%\claude-desktop\config.json`（Windows）に以下を追加します： +`uv pip install git+...` でインストールした場合、`cwd` は **note-mcpを使用するプロジェクトのディレクトリ** を指定します： + +```json +{ + "mcpServers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/your-project" + } + } +} +``` + +#### 開発用インストールの場合 + +`git clone` + `uv sync` でインストールした場合、`cwd` は **クローンしたリポジトリのディレクトリ** を指定します： ```json { @@ -46,9 +66,84 @@ uv run playwright install chromium } ``` +### MCPクライアント別の設定ファイル + +| クライアント | 設定ファイル | +|-------------|-------------| +| Claude Code | `~/.claude.json` または `.mcp.json` | +| Claude Desktop | `~/.config/claude-desktop/config.json` (macOS/Linux) | +| | `%APPDATA%\claude-desktop\config.json` (Windows) | +| VS Code (Copilot Chat, Cline, Continue等) | `.vscode/mcp.json` | +| Cursor | `.cursor/mcp.json` | +| Windsurf | `~/.codeium/windsurf/mcp_config.json` | + ### Claude Code -`.claude/settings.local.json` に以下を追加します： +グローバル設定（`~/.claude.json`）またはプロジェクト設定（`.mcp.json`）に追加： + +```json +{ + "mcpServers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/note-mcp" + } + } +} +``` + +### Claude Desktop + +`~/.config/claude-desktop/config.json`（macOS/Linux）または `%APPDATA%\claude-desktop\config.json`（Windows）に追加： + +```json +{ + "mcpServers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/note-mcp" + } + } +} +``` + +### VS Code拡張 (Copilot Chat, Cline, Continue等) + +`.vscode/mcp.json` に追加： + +```json +{ + "servers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/note-mcp" + } + } +} +``` + +### Cursor + +`.cursor/mcp.json` に追加： + +```json +{ + "mcpServers": { + "note-mcp": { + "command": "uv", + "args": ["run", "python", "-m", "note_mcp"], + "cwd": "/path/to/note-mcp" + } + } +} +``` + +### Windsurf + +`~/.codeium/windsurf/mcp_config.json` に追加： ```json { From 07d650fb63a5e93cbf2eaf288fe04987ffe0a385 Mon Sep 17 00:00:00 2001 From: driller Date: Thu, 15 Jan 2026 10:12:43 +0900 Subject: [PATCH 2/2] fix(#247): apply DRY principle to MCP configuration docs - 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 --- README.md | 115 ++---------------------------------------------------- 1 file changed, 4 insertions(+), 111 deletions(-) diff --git a/README.md b/README.md index 08af39b..fda88fa 100644 --- a/README.md +++ b/README.md @@ -48,104 +48,9 @@ uv run playwright install chromium ## Configuration -MCPクライアントの設定ファイルに以下を追加します。`cwd` はインストール方法によって異なります。 +MCPクライアントの設定ファイルに以下を追加します。詳細は[クイックスタートガイド](docs/quickstart.md#設定)を参照してください。 -### インストール方法別の設定 - -#### パッケージインストールの場合 - -`uv pip install git+...` でインストールした場合、`cwd` は **note-mcpを使用するプロジェクトのディレクトリ** を指定します： - -```json -{ - "mcpServers": { - "note-mcp": { - "command": "uv", - "args": ["run", "python", "-m", "note_mcp"], - "cwd": "/path/to/your-project" - } - } -} -``` - -#### 開発用インストールの場合 - -`git clone` + `uv sync` でインストールした場合、`cwd` は **クローンしたリポジトリのディレクトリ** を指定します： - -```json -{ - "mcpServers": { - "note-mcp": { - "command": "uv", - "args": ["run", "python", "-m", "note_mcp"], - "cwd": "/path/to/note-mcp" - } - } -} -``` - -### MCPクライアント別の設定ファイル - -| クライアント | 設定ファイル | -|-------------|-------------| -| Claude Code | `~/.claude.json` または `.mcp.json` | -| Claude Desktop | `~/.config/claude-desktop/config.json` (macOS/Linux) | -| | `%APPDATA%\claude-desktop\config.json` (Windows) | -| VS Code (Copilot Chat, Cline, Continue等) | `.vscode/mcp.json` | -| Cursor | `.cursor/mcp.json` | -| Windsurf | `~/.codeium/windsurf/mcp_config.json` | - -### Claude Code - -グローバル設定（`~/.claude.json`）またはプロジェクト設定（`.mcp.json`）に追加： - -```json -{ - "mcpServers": { - "note-mcp": { - "command": "uv", - "args": ["run", "python", "-m", "note_mcp"], - "cwd": "/path/to/note-mcp" - } - } -} -``` - -### Claude Desktop - -`~/.config/claude-desktop/config.json`（macOS/Linux）または `%APPDATA%\claude-desktop\config.json`（Windows）に追加： - -```json -{ - "mcpServers": { - "note-mcp": { - "command": "uv", - "args": ["run", "python", "-m", "note_mcp"], - "cwd": "/path/to/note-mcp" - } - } -} -``` - -### VS Code拡張 (Copilot Chat, Cline, Continue等) - -`.vscode/mcp.json` に追加： - -```json -{ - "servers": { - "note-mcp": { - "command": "uv", - "args": ["run", "python", "-m", "note_mcp"], - "cwd": "/path/to/note-mcp" - } - } -} -``` - -### Cursor - -`.cursor/mcp.json` に追加： +### 基本設定 ```json { @@ -159,21 +64,9 @@ MCPクライアントの設定ファイルに以下を追加します。`cwd` } ``` -### Windsurf +> **Note**: `cwd` はインストール方法によって異なります。パッケージインストールの場合はプロジェクトディレクトリ、開発用インストールの場合はクローンしたリポジトリを指定します。詳細は[インストール方法別の設定](docs/quickstart.md#インストール方法別の設定)を参照してください。 -`~/.codeium/windsurf/mcp_config.json` に追加： - -```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）の設定ファイルの場所と詳細は[MCPクライアント別の設定](docs/quickstart.md#mcpクライアント別の設定ファイル)を参照してください。 ## Usage