Docs MCP Server

🚀 ドキュメント - mcp-server

docs-mcp-server は、MCP サーバーの設定や運用を支援するツールです。このツールを使用することで、MCP サーバーの初期化、起動、ビルドなどの操作を簡単に行うことができます。

🚀 クイックスタート

📦 インストール

以下のコマンドを使用して、docs-mcp-server をグローバルにインストールします。

npm install -g docs-mcp-server

💻 使用例

基本的な使用法

インストールが完了したら、以下のコマンドを使用して docs-mcp-server を操作できます。

npx docs-mcp-server <command> [options]

利用可能なコマンドは以下の通りです。

• init: 新しい MCP サーバーの設定ファイルを初期化します。
• serve: MCP サーバーを起動します。
• build: プロジェクトをビルドします。

詳細な情報は、docs-mcp-server --help を参照してください。

環境設定

.env.example を元に .env ファイルを作成します。

cp .env.example .env

.env ファイルに OpenAI API キーを設定します。

# 必須：あなたの OpenAI API キー。
OPENAI_API_KEY=your-api-key-here

# オプション：あなたの OpenAI 組織 ID（LangChain によって自動的に処理されます）
OPENAI_ORG_ID=

# オプション：OpenAI API のカスタムベース URL（Azure OpenAI や互換性のある API など）
OPENAI_API_BASE=

# オプション：埋め込みモデル名（デフォルトは "text-embedding-3-small"）
# 例：text-embedding-3-large, text-embedding-ada-002
DOCS_MCP_EMBEDDING_MODEL=

# オプション：SQLite データベースファイル（documents.db）を保存するカスタムディレクトリを指定します。
# 設定されていない場合、デフォルトの動作は以下の通りです。
# 1. プロジェクトのルートディレクトリ内の './.store/' を使用します（存在する場合は旧バージョン）。
# 2. オペレーティングシステム固有のデータディレクトリ（例：macOS の場合は ~/Library/Application Support/docs-mcp-server）にフォールバックします。
DOCS_MCP_STORE_PATH=/path/to/your/desired/storage/directory

📄 ライセンス

このプロジェクトは、semantic-release と Conventional Commits を使用して自動化されたリリースプロセスを行っています。

仕組み

1. コミットメッセージ：main ブランチにマージされるすべてのコミットは、Conventional Commits 規約に従う必要があります。
2. 手動トリガー：新しいバージョンをリリースする準備ができたら、GitHub Actions のアクションタブから「リリース」ワークフローを手動でトリガーできます。
3. semantic-release アクション：バージョン番号を決定し、CHANGELOG.md と package.json を更新し、変更をコミットし、タグを付け、npm に公開し、GitHub リリースを作成します。

あなたが行う必要があること

• Conventional Commits 形式のコミットメッセージを使用する。
• 変更を main ブランチにマージする。
• 準備ができたら、Actions セクションから新しいリリースを手動でトリガーする。

自動化される処理

• 変更履歴の更新
• バージョン番号の調整
• タグ付け
• npm への公開
• GitHub リリースの作成

🔧 技術詳細

このプロジェクトのアーキテクチャと設計原理については、ARCHITECTURE.md を参照してください。

特に、このプロジェクトの大部分のコードは、AI アシスタント Cline がこの MCP サーバーの機能を使用して生成されています。