search-docs
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| resources | {
"listChanged": true
} |
| completions | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| initA | search-docsの設定ファイルを初期化します。ローカルプロジェクトの文書を検索対象にする場合に実行してください。 |
| get_system_statusA | search-docsの全体状態を確認します。設定状態、インデックス情報、関連プロジェクト一覧が返されます。 |
| searchB | ドキュメントをVector検索します。関連するセクションが関連性順で返されます。 |
| get_documentA | 文書の内容を取得します。セクションの全文はsectionId、文書全体はpathを指定します。 |
| get_outlineA | 文書の目次構造をトークン数付きで一覧表示します。文書の全体像把握や記述量バランスの確認に使えます。 |
| index_statusB | インデックスの詳細な状態を確認します。文書数、セクション数、Dirty数、ワーカー状態が返されます。 |
| list_related_projectsA | 関連プロジェクトの一覧を取得します。設定ファイルで定義されたものとadd_related_projectで追加されたものの両方を表示します。 |
| add_related_projectA | 関連プロジェクトを一時的に追加します（セッション中のみ有効）。対象プロジェクトの起動済みsearch-docsサーバURLを指定してください。 |
| maintenance_repairA | LanceDBテーブルの破損を検出し、自動修復します。破損テーブルはdrop→再作成されます。修復後は再インデックス（index rebuild）が必要です。 |
| index_purgeA | インデックスファイルを全削除します。壊れたインデックスを廃棄して再構築する場合に使います。 |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| search-docsをはじめる | セットアップ手順と設定ファイルの書き方 |
| アーキテクチャ概要 | プロセス構成・Embedding・Worker・Docker・CLI |
| search-docsの使い方 | 検索・文書取得・アウトラインの効果的な使い方 |
| 設定リファレンス | .search-docs.jsonの全オプション解説 |
TDQS
Scored across 10 tools
Each tool has a clearly distinct purpose: status checks, search, outline, index maintenance, related project management, initialization, and document retrieval. No two tools overlap in function or ambiguity.
Naming conventions are inconsistent. While get_* tools are consistent, index_status, index_purge, maintenance_repair, and init deviate from a uniform verb_noun pattern, mixing noun-first and bare verb forms.
10 tools is well within the ideal range for a search-docs server. Each tool covers a distinct aspect of the domain (search, indexing, project management, init) without redundancy.
The surface covers core operations but has gaps: no remove_related_project to complement add_related_project, and no explicit index rebuild tool (only mentioned as a post-repair step). Additionally, there is no direct way to list all documents beyond index status counts.