关键词

Git Spice文档搜索CursorIDE开发助手

Git Spice 文档助手 MCP 服务器

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在为 Cursor IDE 提供实时的 Git Spice 命令文档搜索功能。通过集成到 Cursor IDE 的 MCP 服务器配置中，该服务器可以作为一个工具被 LLM 客户端 (如 Cursor Agent) 调用，从而在用户进行代码编写或咨询时，提供相关的 Git Spice 命令文档上下文信息，提升开发效率。

主要功能点

  • Git Spice 文档搜索: 提供对 Git Spice 官方文档的快速检索能力。
  • Cursor IDE 集成: 通过 MCP 协议无缝集成到 Cursor IDE 环境中。
  • 实时响应: 根据用户查询请求，实时返回相关的文档内容。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/sach999/git-spice-help-mcp
cd git-spice-help-mcp

  2. 安装依赖: 使用 npm 或 yarn 安装项目依赖。

    npm install
# 或
yarn install

  3. 构建项目: 编译 TypeScript 代码到 JavaScript。

    npm run build
# 或
yarn build

服务器配置

为了在 Cursor IDE 中使用此 MCP 服务器，您需要在 Cursor IDE 的扩展设置中添加一个新的 MCP 服务器配置。请按照以下步骤操作：

  1. 打开 Cursor IDE 设置 (macOS: 'Cmd + ,' / Windows/Linux: 'Ctrl + ,')。
  2. 导航到 "Extensions"（扩展）部分。
  3. 找到 MCP Server 设置区域，点击 "Add Server"（添加服务器）按钮。
  4. 填入以下服务器配置信息：
{
  "name": "Git Spice Help MCP Server",  // 服务器名称，自定义即可
  "command": "node",                   // 启动服务器的命令，这里使用 Node.js 运行
  "args": ["dist/index.js"],          // 启动命令的参数，指向编译后的服务器入口文件
  "cwd": "/path/to/your/project"      // 工作目录，请替换为您的项目实际路径，例如：/Users/yourname/git-spice-help-mcp
}

请务必将 '"/path/to/your/project"' 替换为您的 'git-spice-help-mcp' 仓库在您本地文件系统中的绝对路径。

  1. 保存设置并刷新 MCP 服务器。

基本使用方法

完成上述配置后，当您在 Cursor IDE 中开启 Agent 模式时，该 MCP 服务器将自动被检测到。当您在与 Agent 对话或进行代码编辑时，如果 Agent 判断您的query与 Git Spice 命令相关，它将自动调用 'git_spice_help' 工具，并利用此服务器提供的 Git Spice 文档搜索功能来辅助您。您无需手动调用，只需像正常使用 Cursor Agent 一样工作即可。

信息

分类

开发者工具

访问项目