@search-docs/mcp-server 1.5.0 → 1.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +36 -28
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -10,14 +10,14 @@ Claude Codeから直接search-docsを利用するためのMCP Serverです。
10
10
 
11
11
  ### 動的ツール登録
12
12
 
13
- v1.1.6以降、MCP Serverはシステム状態に応じて利用可能なツールを動的に変更します。
13
+ MCP Serverはシステム状態に応じて利用可能なツールを動的に変更します。
14
14
 
15
15
  **システム状態とツールの対応**:
16
16
 
17
- | 状態 | init | server_start | server_stop | get_system_status | search | get_document | index_status |
18
- |------|------|--------------|-------------|-------------------|--------|--------------|--------------|
19
- | NOT_CONFIGURED（未設定） | ✓ | - | - | ✓ | - | - | - |
20
- | CONFIGURED（設定済み） | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
17
+ | 状態 | init | server_start | server_stop | get_system_status | search | get_document | get_outline | index_status |
18
+ |------|------|--------------|-------------|-------------------|--------|--------------|-------------|--------------|
19
+ | NOT_CONFIGURED（未設定） | ✓ | - | - | ✓ | - | - | - | - |
20
+ | CONFIGURED（設定済み） | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
21
21
 
22
22
  **注意**:
23
23
  - `init`実行後、全てのツールが利用可能になります
@@ -32,8 +32,8 @@ v1.1.6以降、MCP Serverはシステム状態に応じて利用可能なツー
32
32
  **利用可能条件**: 常時
33
33
 
34
34
  **パラメータ**:
35
- - `port` (number, オプション): サーバポート番号
36
- - `force` (boolean, オプション): 既存設定を上書き
35
+ - `port` (number, オプション): サーバポート番号（省略時はランダムなポート番号が割り当てられます）
36
+ - `force` (boolean, オプション): 既存設定を上書き（デフォルト: false）
37
37
 
38
38
  #### 2. `server_start`
39
39
  search-docsサーバを起動します。
@@ -41,7 +41,7 @@ search-docsサーバを起動します。
41
41
  **利用可能条件**: 設定済み（CONFIGURED_SERVER_DOWN または RUNNING）
42
42
 
43
43
  **パラメータ**:
44
- - `foreground` (boolean, オプション): フォアグラウンド起動
44
+ - `foreground` (boolean, オプション): フォアグラウンド起動（デフォルト: false、バックグラウンド起動）
45
45
 
46
46
  #### 3. `server_stop`
47
47
  search-docsサーバを停止します。
@@ -51,45 +51,53 @@ search-docsサーバを停止します。
51
51
  **パラメータ**: なし
52
52
 
53
53
  #### 4. `get_system_status`
54
- システムの状態を取得します。
54
+ システムの状態を取得します。設定ファイルの有無、サーバの起動状態、インデックス情報を確認できます。
55
55
 
56
56
  **利用可能条件**: 常時
57
57
 
58
58
  **パラメータ**: なし
59
59
 
60
60
  #### 5. `search`
61
- 文書を検索します。
61
+ 文書を検索します。クエリに基づいてVector検索を実行し、関連する文書セクションを返します。
62
62
 
63
63
  **利用可能条件**: サーバ稼働中（RUNNING）
64
64
 
65
65
  **パラメータ**:
66
66
  - `query` (string, 必須): 検索クエリ
67
- - `depth` (number | number[], オプション): 検索深度（0-3）
67
+ - `project` (string, オプション): 検索対象のプロジェクト名。未指定の場合はメインプロジェクトを検索します
68
+ - `depth` (number, オプション): 最大深度（0-3）。0=文書全体のみ、1=章まで、2=節まで、3=項まで。省略時は全階層を検索
68
69
  - `limit` (number, オプション): 結果数制限（デフォルト: 10）
69
- - `includeCleanOnly` (boolean, オプション): Clean状態のみ検索
70
-
71
- **例**:
72
- ```
73
- query: "Vector検索"
74
- depth: 1
75
- limit: 5
76
- ```
70
+ - `includeCleanOnly` (boolean, オプション): 最新の文書内容のみを検索対象とする（デフォルト: false）
71
+ - `includePaths` (array of string, オプション): 包含するドキュメントパス（前方一致）。例: ["docs/", "README.md"]
72
+ - `excludePaths` (array of string, オプション): 除外するドキュメントパス（前方一致）。例: ["docs/internal/", "temp/"]
73
+ - `previewLines` (number, オプション): プレビュー行数（デフォルト: 5）
77
74
 
78
75
  #### 6. `get_document`
79
- 文書の内容を取得します。
76
+ 文書の内容を取得します。パス指定で文書全体、またはセクションIDで特定セクションを取得できます。
80
77
 
81
78
  **利用可能条件**: サーバ稼働中（RUNNING）
82
79
 
83
80
  **パラメータ**:
84
- - `path` (string, 必須): 文書パス
81
+ - `path` (string, オプション): 文書パス（sectionIdを指定しない場合は必須）
82
+ - `sectionId` (string, オプション): セクションID（検索結果から取得、pathを指定しない場合は必須）
83
+ - `project` (string, オプション): 取得対象のプロジェクト名
85
84
 
86
- **例**:
87
- ```
88
- path: "docs/architecture.md"
89
- ```
85
+ **注意**: pathとsectionIdのどちらか一方は必須です。
86
+
87
+ #### 7. `get_outline`
88
+ 文書の構造（アウトライン）を取得します。セクション番号、見出し、行数、トークン数、セクションIDを一覧表示します。
89
+
90
+ **利用可能条件**: サーバ稼働中（RUNNING）
91
+
92
+ **パラメータ**:
93
+ - `path` (string, オプション): 文書パス（sectionIdを指定しない場合は必須）
94
+ - `sectionId` (string, オプション): セクションID（指定した場合、そのセクション配下のみ表示）
95
+ - `project` (string, オプション): 取得対象のプロジェクト名
96
+
97
+ **注意**: pathとsectionIdのどちらか一方は必須です。
90
98
 
91
- #### 7. `index_status`
92
- インデックスの状態を確認します。
99
+ #### 8. `index_status`
100
+ インデックスの状態を確認します。総文書数、セクション数、Dirtyセクション数などを表示します。
93
101
 
94
102
  **利用可能条件**: サーバ稼働中（RUNNING）
95
103
 
@@ -99,7 +107,7 @@ path: "docs/architecture.md"
99
107
 
100
108
  ### サーバ自動起動機能
101
109
 
102
- v1.0.1以降、MCP Serverは自動的にsearch-docsサーバを起動します。
110
+ MCP Serverは自動的にsearch-docsサーバを起動します。
103
111
 
104
112
  **動作**:
105
113
  1. MCP Server起動時にサーバへの接続を試みる
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@search-docs/mcp-server",
3
- "version": "1.5.0",
3
+ "version": "1.5.2",
4
4
  "description": "MCP Server for search-docs - Claude Code integration",
5
5
  "type": "module",
6
6
  "main": "dist/server.js",
@@ -16,7 +16,7 @@
16
16
  "@modelcontextprotocol/sdk": "^1.17.0",
17
17
  "commander": "^12.0.0",
18
18
  "zod": "^3.22.0",
19
- "@search-docs/cli": "1.0.34",
19
+ "@search-docs/cli": "1.0.36",
20
20
  "@search-docs/client": "1.0.17",
21
21
  "@search-docs/types": "1.3.2"
22
22
  },