项目简介
本项目是为 Zed 代码编辑器开发的一个扩展,它集成了 GitHub MCP (Model Context Protocol) 服务器。通过这个扩展,Zed 编辑器可以利用 GitHub 上的数据作为上下文信息,增强代码编辑和智能辅助功能。它实际上并非直接实现 MCP 服务器,而是 Zed 编辑器用来启动和管理官方 '@modelcontextprotocol/server-github' MCP 服务器的桥梁。
主要功能点
- GitHub 数据访问: 允许 Zed 编辑器通过 MCP 协议访问 GitHub 仓库、Issue、Pull Request 等资源,为编辑器提供丰富的上下文信息。
- 代码仓库浏览: 支持在 Zed 编辑器中浏览和搜索 GitHub 代码仓库的内容。
- 问题追踪: 集成 GitHub Issues 和 Pull Requests,方便开发者在编辑器中进行问题跟踪和协作。
- 上下文增强: 为 Zed 编辑器的智能助手提供 GitHub 上下文信息,提升代码补全、问题解答等智能功能的效果。
- 自动化安装和管理: 扩展程序能够自动安装和更新 '@modelcontextprotocol/server-github' Node.js 包,简化服务器的部署和管理。
安装步骤
- 安装 Zed 编辑器扩展: 此扩展是为 Zed 编辑器开发的,您需要在 Zed 编辑器中安装此扩展。具体的安装方法请参考 Zed 编辑器的扩展安装文档。
- 配置 GitHub Personal Access Token (PAT): 为了让 MCP 服务器能够访问您的 GitHub 仓库,您需要创建一个具有 'repo' 权限的 GitHub Personal Access Token。
- 访问 GitHub Token 设置页面。
- 点击 "Generate new token" -> "Generate new token (classic)"。
- 在 "Note" 中输入描述信息,例如 "Zed MCP Server"。
- 勾选 "repo" 权限。
- 点击 "Generate token" 生成 Token。
- 复制生成的 Token,并妥善保管。
服务器配置
MCP 服务器的配置需要在 Zed 编辑器的 'settings.json' 文件中进行配置。在 'context_servers' 字段下添加 'mcp-server-github' 配置项。
"context_servers": { "mcp-server-github": { "settings": { "github_personal_access_token": "<请替换为您的 GitHub Personal Access Token>" } } },
配置参数说明:
- 'context_servers': 定义上下文服务器的配置。
- 'mcp-server-github': 为当前 GitHub MCP 服务器扩展定义的名称,用于 Zed 编辑器识别和加载。
- 'settings': 服务器的设置项。
- 'github_personal_access_token': 必填,您在 GitHub 上生成的 Personal Access Token,用于服务器访问 GitHub API。 请务必替换 '<请替换为您的 GitHub Personal Access Token>' 为您实际的 Token 值。
无需手动配置服务器启动命令 (command) 和参数 (args)。 Zed 编辑器扩展会自动处理 '@modelcontextprotocol/server-github' Node.js 包的安装、更新和启动,并传递必要的配置信息。
基本使用方法
- 启动 Zed 编辑器: 启动安装了此扩展的 Zed 编辑器。
- 打开项目: 打开您想要使用 GitHub 上下文信息的代码项目。
- 使用 Zed 编辑器的智能功能: 此扩展主要为 Zed 编辑器的智能功能提供上下文支持。您可以尝试使用 Zed 编辑器的智能助手、代码补全、代码搜索等功能,体验 GitHub 上下文带来的增强效果。 例如,您可以:
- 在 Zed 编辑器的 AI Assistant 中询问关于 GitHub 仓库的问题,例如 "当前仓库有哪些未解决的 Issues?"
- 在代码编辑器中使用代码补全功能,可能会根据 GitHub 仓库中的代码提供更相关的建议。
- 使用 Zed 编辑器的代码搜索功能,搜索范围可能包含 GitHub 仓库的内容。
注意: 此扩展作为 Zed 编辑器的插件运行,您不需要手动启动 MCP 服务器。服务器会在 Zed 编辑器需要时自动启动。 您主要通过 Zed 编辑器的界面和功能来间接使用 GitHub MCP 服务器提供的上下文信息。
信息
分类
开发者工具