使用说明
模型上下文协议(MCP)提示和最佳实践
什么是MCP?
模型上下文协议(MCP)是一种使AI模型能够与开发环境和工具通信的协议。它允许AI助手以结构化和安全的方式收集上下文、执行命令并对代码库进行更改。MCP服务器充当AI模型和开发环境之间的中介,为交互提供标准化的接口。
安装指南
先决条件
- Docker已安装在您的系统上
- 具有适当权限的GitHub个人访问令牌(PAT)
- 带有必要扩展名的VS代码
基本设置步骤
-
环境配置
- 将您的GitHub令牌设置为环境变量:
export GITHUB_TOKEN=your_token_here
- 将您的GitHub令牌设置为环境变量:
-
Docker镜像
- MCP服务器在Docker容器中运行
- 官方图片可在以下网址获得:
ghcr.io/github/github-mcp-server
-
VS代码设置
- 在VS Code settings.json中配置MCP服务器
- 基本配置示例:
{ "mcp": { "servers": { "github": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN=${env:GITHUB_TOKEN}", "ghcr.io/github/github-mcp-server" ], "env": { "GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_TOKEN" } } } } }
配置提示
最佳实践
-
令牌安全
- 永远不要将GitHub令牌提交给版本控制
- 对敏感信息使用环境变量
- 定期轮换您的PAT以确保安全
-
Docker配置
- 使用
--rm停止后自动删除容器的标志 - 考虑对持久数据使用卷装载
- 将Docker镜像更新到最新版本
- 使用
-
VS代码集成
- 保持您的VS代码和扩展的更新
- 适当配置日志记录级别
- 需要时使用工作区特定的设置
故障排除
常见问题及解决方法
-
连接问题
- 验证Docker是否正在运行
- 检查您的GitHub令牌是否有效且设置正确
- 确保与GitHub的网络连接正确
-
身份验证问题
- 验证您的PAT是否具有所需的范围
- 检查环境变量配置
- 确保令牌未过期
-
Docker相关问题
- 如果遇到映像问题,请清除Docker缓存
- 检查Docker日志以获取详细的错误消息
- 验证Docker是否有足够的系统资源
-
VS代码集成问题
- 如果需要,将VS代码设置重置为默认值
- 检查VS Code的扩展日志
- 验证settings.json中的MCP配置语法
调试提示
- 在VS代码中启用详细日志记录
- 检查Docker容器日志
- 验证环境变量的可用性
- 监控系统资源使用情况
高级配置
自定义服务器配置
- 配置多个MCP服务器
- 设置自定义环境变量
- 配置资源限制
性能优化
- 配置缓存设置
- 优化Docker容器资源
- 设置适当的超时值
