使用说明
团队指导mcp
模型上下文协议（MCP）服务器，可提供干净的代码指南文档并检查外部项目的代码。
主要功能
- 📚 提供指南文档：阅读各种指南文档，包括清洁代码编写指南
- 📖 读取外部文件：可以读取并分析外部项目中的文件
- 🔍 清洁代码检查：基于指南的代码质量检查和改进建议
🚀 快速入门
1.安装
如果安装了npm软件包，则可以立即使用。
2.MCP客户端设置
Cursor/Claude桌面设置示例：
{
"mcpServers": {
"guide-mcp": {
"command": "npx",
"args": ["-y", "teams-guide-mcp"]
}
}
}
设置后重新启动MCP客户端。
🛠️ 可用工具
get_guide
读取并返回指南文档的内容。
参数：
fileName（必需）：要读取的指南文件名（例如：clean-code-guide.md)
使用示例：
"clean-code-guide.md 가이드를 읽어줘"
read_file
读取并返回外部项目的文件。
参数：
filePath（必需）：要读取的文件路径（相对路径或绝对路径）
使用示例：
"read_file 도구로 ./src/utils.js 파일을 읽어줘"
check_clean_code
根据清洁代码指南检查文件。
参数：
filePath（必需）：要检查的文件路径guideName（可选）：要使用的指南文件名（默认为：clean-code-guide.md)
使用示例：
"check_clean_code로 ./src/index.js 파일을 클린 코드 가이드로 검사해줘"
📚 可用资源
在MCP客户端上 guide://파일명 您可以直接以格式访问指南文档。
示例： guide://clean-code-guide.md
💡 使用方案
方案1：阅读清洁代码指南
"클린 코드 가이드의 네이밍 규칙을 알려줘"
方案2：读取外部文件
"read_file로 ./src/utils.js를 읽어줘"
方案3:检查干净代码
"check_clean_code로 ./src/index.js를 검사하고 개선 사항을 제안해줘"
📁 项目结构
teams-guide-mcp/
├── src/
│ └── index.js # MCP 서버 메인 코드
├── guides/
│ └── clean-code-guide.md # 클린 코드 가이드 문서
└── package.json
🔧 开发者
添加指南文档
guides/ 目录中 .md 或 .txt 添加文件时会自动识别文件。
版本控制和部署
该项目使用GitHub Actions支持自动部署。
设置自动部署
标记为 v*.*.* 以格式推送时自动：
package.json更新版本- 将包分发到npm
- 生成GitHub Release
📋 要求
- Node.js v20.18.0或更高版本
- npm
📄 许可证
麻省理工学院
