关键词

GitHub APIMCP Server自动化上下文服务开发工具

使用说明

项目简介

本项目 MCP-SERVER 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在为大型语言模型（LLM）客户端提供与 GitHub 交互的上下文信息和功能。它允许 LLM 通过标准化的 MCP 协议访问和操作 GitHub 资源。

主要功能点

  • 资源 (Resources):
    • Note 资源: 提供简单的笔记存储系统，允许 LLM 客户端访问和管理笔记资源，使用自定义 'note://' URI 方案。
  • Prompt 模板 (Prompts):
    • summarize-notes: 允许 LLM 客户端请求服务器生成所有存储笔记的摘要，并支持通过可选的 "style" 参数控制摘要的详细程度（brief/detailed）。
  • 工具 (Tools):
    • add-note: 允许 LLM 客户端通过调用该工具向服务器添加新的笔记，支持 "name" 和 "content" 参数，并实时通知客户端资源变更。

安装步骤

  1. 安装 Claude Desktop 客户端 (如果尚未安装)。
  2. 配置 MCP 服务器:
    • 根据您的操作系统，编辑 Claude Desktop 的配置文件 'claude_desktop_config.json'：
      • MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
      • Windows: '%APPDATA%/Claude/claude_desktop_config.json'
    • 在 'claude_desktop_config.json' 文件中，找到或创建 '"mcpServers"' 部分。
    • 在 '"mcpServers"' 中添加 "MCP-GITHUB-SERVER" 的配置信息 (参考 服务器配置 部分)。

服务器配置

将以下 JSON 配置添加到 'claude_desktop_config.json' 的 '"mcpServers"' 字段中，以配置 "MCP-GITHUB-SERVER"：

"MCP-GITHUB-SERVER": {
  "command": "uv",
  "args": [
    "--directory",
    "C:\Users\DELL\Desktop\mcp-github-server\MCP-GITHUB-SERVER",
    "run",
    "MCP-GITHUB-SERVER"
  ]
}

参数说明:

  • '"MCP-GITHUB-SERVER"': 服务器名称，Claude Desktop 客户端中用于标识和调用此服务器。
  • '"command": "uv"': 启动服务器的命令，这里使用 'uv' (需确保已安装 uv)。
  • '"args"': 传递给 'uv' 命令的参数列表：
    • '"--directory"': 指定服务器代码所在的目录。请将 '"C:\Users\DELL\Desktop\mcp-github-server\MCP-GITHUB-SERVER"' 替换为您的 'MCP-SERVER' 仓库的实际路径。
    • '"run"': 'uv' 命令的子命令，用于运行 Python 脚本。
    • '"MCP-GITHUB-SERVER"': 要运行的 Python 脚本名称，这里指 'main.py' 文件 (仓库根目录下的 'MCP-GITHUB-SERVER' 实际上是包含 'main.py' 的目录名)。

基本使用方法

  1. 设置 GitHub API Token:
    • 您需要在 'config.py' 文件中配置 'GITHUB_API_TOKEN' 变量，或者设置名为 'GITHUB_API_TOKEN' 的环境变量，用于 GitHub API 的身份验证。
  2. 启动 MCP 服务器:
    • 根据 服务器配置 中的说明，配置好 'claude_desktop_config.json' 后，当 Claude Desktop 客户端启动并尝试连接 MCP 服务器时，将自动运行配置的命令来启动 GitHub MCP Server。
  3. 在 Claude Desktop 客户端中使用:
    • 在 Claude Desktop 客户端中，您应该能够配置和连接到名为 "MCP-GITHUB-SERVER" 的 MCP 服务器。
    • 连接成功后，您可以使用服务器提供的资源 (例如 'note://...')、Prompt (例如 'summarize-notes') 和工具 (例如 'add-note') 与 GitHub 进行交互。
  4. 调试:
    • 为了更好的调试体验，建议使用 MCP Inspector 工具。按照仓库 README 中的 Debugging 部分的指引启动 MCP Inspector 并进行调试。

注意: 请务必将配置中的路径 '"C:\Users\DELL\Desktop\mcp-github-server\MCP-GITHUB-SERVER"' 替换为您本地 'MCP-SERVER' 仓库的实际路径。

信息

分类

开发者工具

访问项目