文件最后提交记录最后更新时间
10 个月前
10 个月前
11 个月前
10 个月前
10 个月前
10 个月前
1 年前
README

GitCode MCP 示例文件

本目录包含各种配置文件和示例,帮助您快速开始使用GitCode MCP服务。

配置文件

以下是不同客户端环境的配置文件样例:

claude_config.json

适用于Claude AI助手的配置文件。此文件符合最新的MCP配置格式,可以作为Claude Desktop应用中MCP服务器配置的参考。

主要配置项:

  • mcpServers.gitcode: 服务器配置对象
    • command 和 args: 启动MCP服务的命令
    • env.GITCODE_TOKEN: GitCode个人访问令牌
    • description: 服务描述
    • instructions: 使用说明

cursor_config.json

用于Cursor IDE的配置文件。此文件符合Cursor最新的MCP配置格式,可以作为以下两种配置的参考:

  1. 项目级配置:将内容复制到项目根目录的.cursor/mcp.json文件中
  2. 全局配置:将内容复制到用户主目录的~/.cursor/mcp.json文件中

主要配置项:

  • mcpServers.gitcode: 服务器配置对象
    • command 和 args: 启动MCP服务的命令
    • env.GITCODE_TOKEN: GitCode个人访问令牌

windsurf_config.json

WindSurf编辑器的配置文件,用于在WindSurf中启用GitCode功能。此文件也采用最新的MCP配置格式。

主要配置项:

  • mcpServers.gitcode: 服务器配置对象
    • command 和 args: 启动MCP服务的命令
    • env.GITCODE_TOKEN: GitCode个人访问令牌

cline_config.json

命令行工具的配置样例,包含以下配置选项:

  • API连接参数
  • 默认仓库设置
  • 输出格式控制
  • 缓存设置
  • 日志记录配置

这个配置文件主要用于GitCode命令行工具,而非MCP服务器配置。

示例代码

client_example.py

展示如何使用GitCode MCP客户端API进行编程交互的示例脚本。

使用方法

  1. 复制相应的配置文件到您的环境中
  2. 将your_personal_access_token_here替换为您的实际GitCode访问令牌
  3. 根据需要调整其他配置参数
  4. 根据不同客户端的文档,将配置文件放置在正确的位置

基础配置

最简单的配置只需要设置 GITCODE_TOKEN:

{
  "mcpServers": {
    "gitcode": {
      "command": "python",
      "args": ["-m", "gitcode_mcp"],
      "env": {
        "GITCODE_TOKEN": "your_personal_access_token_here"
      }
    }
  }
}

代理配置

如果您需要通过HTTP代理访问GitCode,可以添加代理配置:

{
  "mcpServers": {
    "gitcode": {
      "command": "python",
      "args": ["-m", "gitcode_mcp"],
      "env": {
        "GITCODE_TOKEN": "your_personal_access_token_here",
        "HTTP_PROXY": "http://localhost:8080",
        "HTTPS_PROXY": "http://localhost:8080"
      }
    }
  }
}

支持的代理环境变量:

  • HTTP_PROXY: HTTP代理地址(例如: http://proxy.example.com:8080)
  • HTTPS_PROXY: HTTPS代理地址(例如: http://proxy.example.com:8080)

代理地址格式支持:

  • http://proxy.example.com:8080 - 基础代理
  • http://user:password@proxy.example.com:8080 - 带认证的代理
  • socks5://proxy.example.com:1080 - SOCKS5代理(需要额外的依赖)

注意:配置文件中的每个服务器配置(如 gitcode 和 gitcode-with-proxy)是独立的示例,您只需选择一个并根据实际情况修改即可。

获取访问令牌

  1. 登录您的GitCode账户
  2. 前往个人设置 -> 访问令牌
  3. 创建新的个人访问令牌,并确保勾选需要的权限范围
  4. 将生成的令牌复制到配置文件中相应位置