Git Spice Documentation Search

🚀 光標 MCP 服務器

本項目實現了一個模型上下文協議（MCP）服務器，為光標 IDE 提供了搜索 git-spice 文檔的實用工具，極大提升了開發過程中的信息檢索效率。

🚀 快速開始

此 MCP 服務器能與光標 IDE 深度集成，藉助 MCP 協議實現即時的 git-spice 文檔搜索。使用前請確保已滿足以下先決條件：

• Node.js（v16 或更高版本）
• 光標 IDE
• npm 或 yarn 包管理器

✨ 主要特性

• 光標 IDE 集成：通過 MCP 協議無縫集成至光標 IDE，為開發者提供便捷的文檔搜索入口。
• 即時搜索：支持對 git-spice 文檔進行即時搜索，快速定位所需信息。
• 高效解析：採用簡單高效的文檔解析方式，確保搜索結果的準確性和及時性。

📦 安裝指南

克隆倉庫

git clone <repository-url>
cd <repository-name>

安裝依賴

npm install
# 或者
yarn install

構建項目

npm run build
# 或者
yarn build

📚 詳細文檔

服務器配置

服務器預先配置了以下實用功能：

• 工具功能
• 資源功能
• 提示功能

光標 IDE 配置

1. 打開光標 IDE 設置：
   • 在 macOS 上：使用快捷鍵 Cmd + ,
   • 在 Windows/Linux 上：使用快捷鍵 Ctrl + ,
2. 導航至“擴展”部分。
3. 找到 MCP 服務器設置並添加新的服務器配置：

{
  "name": "Git Spice MCP Server",
  "command": "node",
  "args": ["dist/index.js"],
  "cwd": "/path/to/your/project"
}

4. 保存設置並刷新 MCP。

💻 使用示例

當使用光標代理模式時，MCP 服務器會被自動檢測到，git-spice 文檔搜索工具隨即可用。代理會在相關查詢時提示您使用該工具。

🔧 技術細節

項目結構

• src/index.ts：主服務器實現文件，承載服務器的核心邏輯。
• src/：源代碼目錄，包含項目的所有源代碼。
• dist/：編譯輸出目錄，存放編譯後的文件。

📄 許可證

文檔中未提及相關許可證信息。

致謝

感謝以下項目和工具的支持：

• 模型上下文協議
• git-spice
• 光標 IDE