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