--- slug: "shared-knowledge-mcp-server" source_type: "readme" source_url: "https://cdn.jsdelivr.net/gh/j5ik2o/shared-knowledge-mcp@main/README.md" repo: "https://github.com/j5ik2o/shared-knowledge-mcp" source_file: "README.md" branch: "main" --- # Shared Knowledge MCP Server 各種AIアシスタント（CLINE, Cursor, Windsurf, Claude Desktop）で共通して使用できるナレッジベースMCPサーバーです。 Retrieval Augmented Generation (RAG)を活用して、効率的な情報検索と利用を実現します。 複数のAIアシスタントツール間でナレッジベースを共有することで、一貫した情報アクセスを提供します。 ## 特徴 - 複数のAIアシスタント間で共通のナレッジベースを使用可能 - RAGによる高精度な情報検索 - TypeScriptによる型安全な実装 - 複数のベクトルストア（HNSWLib, Chroma, Pinecone, Milvus）をサポート - 抽象化されたインターフェースによる拡張性 ## インストール ```bash git clone https://github.com/yourusername/shared-knowledge-mcp.git cd shared-knowledge-mcp npm install ``` ## 設定 MCPサーバーの設定は、各AIアシスタントの設定ファイルに追加します。 ### VSCode (CLINE/Cursor用) `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`: ```json { "mcpServers": { "shared-knowledge-base": { "command": "node", "args": ["/path/to/shared-knowledge-mcp/dist/index.js"], "env": { "KNOWLEDGE_BASE_PATH": "/path/to/your/rules", "OPENAI_API_KEY": "your-openai-api-key", "SIMILARITY_THRESHOLD": "0.7", "CHUNK_SIZE": "1000", "CHUNK_OVERLAP": "200", "VECTOR_STORE_TYPE": "hnswlib" } } } } ``` ### Pineconeを使用する例 ```json { "mcpServers": { "shared-knowledge-base": { "command": "node", "args": ["/path/to/shared-knowledge-mcp/dist/index.js"], "env": { "KNOWLEDGE_BASE_PATH": "/path/to/your/rules", "OPENAI_API_KEY": "your-openai-api-key", "VECTOR_STORE_TYPE": "pinecone", "VECTOR_STORE_CONFIG": "{\"apiKey\":\"your-pinecone-api-key\",\"environment\":\"your-environment\",\"index\":\"your-index-name\"}" } } } } ``` ### Claude Desktop `~/Library/Application Support/Claude/claude_desktop_config.json`: #### HNSWLib（デフォルト）を使用する例 ```json { "mcpServers": { "shared-knowledge-base": { "command": "node", "args": ["/path/to/shared-knowledge-mcp/dist/index.js"], "env": { "KNOWLEDGE_BASE_PATH": "/path/to/your/docs", "OPENAI_API_KEY": "your-openai-api-key", "SIMILARITY_THRESHOLD": "0.7", "CHUNK_SIZE": "1000", "CHUNK_OVERLAP": "200", "VECTOR_STORE_TYPE": "hnswlib", "VECTOR_STORE_CONFIG": "{}" }, "disabled": false, "autoApprove": [] } } } ``` #### Weaviateを使用する例 ```json { "mcpServers": { "shared-knowledge-base": { "command": "node", "args": ["/path/to/shared-knowledge-mcp/dist/index.js"], "env": { "KNOWLEDGE_BASE_PATH": "/path/to/your/docs", "OPENAI_API_KEY": "your-openai-api-key", "SIMILARITY_THRESHOLD": "0.7", "CHUNK_SIZE": "1000", "CHUNK_OVERLAP": "200", "VECTOR_STORE_TYPE": "weaviate", "VECTOR_STORE_CONFIG": "{\"url\":\"http://localhost:8080\",\"className\":\"Document\",\"textKey\":\"content\"}" }, "disabled": false, "autoApprove": [] } } } ``` **注意**: Weaviateを使用する場合は、事前にWeaviateサーバーを起動しておく必要があります。以下のコマンドで起動できます： ```bash ./start-weaviate.sh ``` ## 開発 ### 開発用サーバーの起動 ```bash npm run dev ``` ### ビルド ```bash npm run build ``` ### 本番環境での実行 ```bash npm start ``` ## 使用可能なツール ### rag_search ナレッジベースから情報を検索します。 #### 検索リクエスト ```typescript interface SearchRequest { // 検索クエリ（必須） query: string; // 返す結果の最大数（デフォルト: 5） limit?: number; // 検索のコンテキスト（オプション） context?: string; // フィルタリングオプション（オプション） filter?: { // ドキュメントの種類でフィルタリング（例: ["markdown", "code"]） documentTypes?: string[]; // ソースパスのパターンでフィルタリング（例: "*.md"） sourcePattern?: string; }; // 結果に含める情報（オプション） include?: { metadata?: boolean; // メタデータを含める summary?: boolean; // 要約を生成 keywords?: boolean; // キーワードを抽出 relevance?: boolean; // 関連性の説明を生成 }; } ``` #### 使用例 基本的な検索： ```typescript const result = await callTool("rag_search", { query: "コミットメッセージのフォーマット", limit: 3 }); ``` 高度な検索： ```typescript const result = await callTool("rag_search", { query: "コミットメッセージのフォーマット", context: "Gitの使い方について調査中", filter: { documentTypes: ["markdown"], sourcePattern: "git-*.md" }, include: { summary: true, keywords: true, relevance: true } }); ``` #### 検索結果 ```typescript interface SearchResult { // 検索クエリに関連する文書の内容 content: string; // 類似度スコア（0-1） score: number; // ソースファイルのパス source: string; // 位置情報 startLine?: number; // 開始行 endLine?: number; // 終了行 startColumn?: number; // 開始桁 endColumn?: number; // 終了桁 // ドキュメントの種類（例: "markdown", "code", "text"） documentType?: string; // 追加情報（include オプションで指定した場合のみ） summary?: string; // コンテンツの要約 keywords?: string[]; // 関連キーワード relevance?: string; // 関連性の説明 metadata?: Record; // メタデータ } ``` #### レスポンス例 ```json { "results": [ { "content": "# コミットメッセージのフォーマット\n\n以下の形式でコミットメッセージを記述してください：\n\n```\n(): \n\n\n\n