Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ uv run playwright install chromium

## Configuration

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

`~/.config/claude-desktop/config.json`(macOS/Linux)または `%APPDATA%\claude-desktop\config.json`(Windows)に以下を追加:
### 基本設定

```json
{
Expand All @@ -64,6 +64,10 @@ uv run playwright install chromium
}
```

> **Note**: `cwd` はインストール方法によって異なります。パッケージインストールの場合はプロジェクトディレクトリ、開発用インストールの場合はクローンしたリポジトリを指定します。詳細は[インストール方法別の設定](docs/quickstart.md#インストール方法別の設定)を参照してください。

各MCPクライアント(Claude Code, Claude Desktop, VS Code, Cursor, Windsurf)の設定ファイルの場所と詳細は[MCPクライアント別の設定](docs/quickstart.md#mcpクライアント別の設定ファイル)を参照してください。

## Usage

### 1. ログイン
Expand Down
101 changes: 98 additions & 3 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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
{
Expand Down