article
README
🚀 GitHub MCP 服务器使用说明
本项目提供了一系列操作 GitHub 仓库的功能,能创建新问题、获取仓库信息等,还支持多种搜索语法,帮助你高效使用 GitHub。
🚀 快速开始
在使用 GitHub MCP 服务器前,你需要完成相关配置。具体步骤如下:
- 创建个人访问令牌:创建 GitHub 个人访问令牌 并确保其具有适当的权限。访问 个人访问令牌(在 GitHub 设置 > 开发者设置中),选择该令牌可以访问的仓库范围(公共、全部或特定仓库),创建一个具有
repo权限范围的令牌(“对私有仓库进行全面控制”),如果仅用于公开仓库,可以选择public_repo权限范围,最后复制生成的令牌。 - 在 Claude Desktop 上配置:在
claude_desktop_config.json中添加以下配置:
{
"githubMCP": {
"token": "your_personal_access_token_here",
"baseUrl": "https://api.github.com"
}
}
✨ 主要特性
1. 创建新问题
- 函数:
createIssue - 输入参数:
owner:仓库所有者名称(例如:octocat)repo:仓库名称(例如:hello-world)title:问题标题(例如:这是一个新问题)body:问题描述
- 输出:新创建的问题对象
2. 获取仓库信息
- 函数:
getRepositoryInfo - 输入参数:
owner:仓库所有者名称repo:仓库名称
- 输出:包含仓库详细信息的对象,包括成员、分支等信息
3. 获取仓库内容
- 函数:
getContents - 输入参数:
owner:仓库所有者名称repo:仓库名称path:文件路径(可选)
- 输出:指定路径下的文件或目录列表
...(其他功能省略)
📚 详细文档
搜索语法说明
代码搜索
language:javascript:根据编程语言筛选repo:owner/name:在特定仓库中搜索path:app/src:在指定路径下搜索extension:js:根据文件扩展名筛选- 示例:
q: "import express" language:typescript path:src/
问题搜索
is:issue或is:pr:根据类型筛选is:open或is:closed:根据状态筛选label:bug:根据标签筛选author:username:根据作者筛选- 示例:
q: "memory leak" is:issue is:open label:bug
用户搜索
type:user或type:org:根据账户类型筛选followers:>1000:根据关注者数量筛选location:London:根据位置筛选- 示例:
q: "fullstack developer" location:London followers:>100
💻 使用示例
基础用法
创建新问题
调用 createIssue 函数:
- 输入参数:
owner:octocatrepo:hello-worldtitle:这是一个新问题body:请帮我解决这个问题。
获取仓库信息
调用 getRepositoryInfo 函数:
- 输入参数:
owner:octocatrepo:hello-world
📄 许可证
文档中未提及许可证相关信息。
🔗 文档参考
请根据实际需求调整上述配置和函数调用。
微信扫一扫