项目定制MCP服务器

一个开源的MCP服务器,通过分析代码库并基于行业最佳实践生成AI就绪的配置文件,自动完成项目定制。

  • by e1imba
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 e1imba/project-customization-mcp

使用说明

项目定制MCP

一个开源的MCP(模型上下文协议)服务器,通过分析您的代码库并根据行业最佳实践生成AI就绪的配置文件来自动化项目定制。非常适合需要一致、框架感知的项目指导方针的团队和个人开发人员。

平台无关:适用于支持模型上下文协议的任何IDE、编辑器或AI工具(VS Code、JetBrains、Cursor、Claude等)

所得

此工具自动执行以下操作:

  • 🔍 分析您的项目 -检测框架、语言和项目结构
  • 📝 生成指导方针 -创建 .github/copilot-instructions.md 为了持续发展
  • ✍️ 更新文档 -使用最佳实践增强README
  • 💡 提供建议 -建议对代码库进行改进

🎯 可用工具

  • 🔎 analyze_project -扫描您的项目并检测框架/语言
  • 📋 generate_copilot_instructions -为您的项目创建自定义指南
  • 📄 update_readme -使用标准生成或增强README
  • 🚀 get_customization_recommendations -获取可操作的改进建议

📚 可用资源

  • 📦 项目元数据 -您的项目类型、框架、语言
  • 📁 项目结构 -目录组织和文件
  • 📖 现行指南 -现有自定义文件
  • 📝 自述文件 -您当前的文档

💬 可用提示

  • ⚡ analyze-and-customize -完整的工作流程(分析→ 生成→ 更新)
  • ✨ generate-instructions-only -只创建指令文件
  • 🔄 review-and-improve -查看现有自定义设置

📦 安装

⚙️ 选项1:使用npx(推荐-无需安装)

{
  "mcpServers": {
    "project-customization": {
      "command": "npx",
      "args": ["-y", "project-customization-mcp"]
    }
  }
}

🌍 选项2:全局npm安装

npm install -g project-customization-mcp

然后配置:

{
  "mcpServers": {
    "project-customization": {
      "command": "project-customization-mcp",
      "env": {
        "MCP_API_KEY": "YOUR_KEY"
      }
    }
  }
}

🔐 授权(仅限工具)

工具执行需要通过配置API密钥 MCP_API_KEY 在MCP服务器配置中 env。如果密钥丢失,工具调用将返回授权错误。提示和资源仍然可用,无需任何密钥。

配置示例:

{
  "mcpServers": {
    "project-customization": {
      "command": "project-customization-mcp",
      "env": {
        "MCP_API_KEY": "YOUR_KEY"
      }
    }
  }
}

🧠 内存(GitHub Copilot托管)

此MCP服务器不存储内存。根据GitHub的Copilot内存文档,将GitHub的托管内存功能用于长期上下文。

🚀 如何使用

1.️⃣ 在IDE中配置

  • VS Code: Ctrl+Shift+P → “MCP:打开用户配置”
  • 光标:设置→ MCP服务器
  • 其他IDE:请参阅IDE的MCP文档

添加上述配置之一,然后重新启动IDE。

2.️⃣ 在聊天中使用

打开聊天并键入:

Analyze my project and set up customization based on best practices

或使用特定提示:

/analyze-and-customize
/generate-instructions-only
/review-and-improve

3.添加聊天资源

添加项目上下文:

  • 选择“添加上下文”→ “MCP资源”
  • 选择:项目元数据、项目结构、指南、README

📋 生成什么

该工具创建或更新:

  • ✅ .github/copilot-instructions.md -项目特定指南和标准
  • ✅ README.md -通过设置和开发指南进行了增强
  • ✅ 建议 -针对框架的改进建议

📊 输出示例

对于React TypeScript项目,你会得到:

# Project Guidelines

## Code Style

- Use functional components with hooks
- Maintain strict TypeScript (no `any`)
- ESLint + Prettier for formatting

## Project Structure

- src/components - React components
- src/pages - Page components
- src/utils - Utilities
- src/hooks - Custom hooks

📄 许可证

MIT许可证-请参阅 许可证 文件


🎉 为模型上下文协议而设计 |适用于任何MCP兼容客户端