mcpbestpractices

MCP 最佳实践服务器

 ](https://badge.fury.io/js/mcp-best-practices-server)

一个MCP（模型上下文协议）服务器，为多种编程语言和框架提供编码最佳实践、指南以及代码审查功能。兼容VS Code、GitHub Copilot和其他MCP客户端。

🚀 快速入门

VS Code一键安装

点击此链接以在VS Code中自动安装并配置服务器：

📦 在 VS Code 中安装

手动安装

选项1：全局安装

npm install -g mcp-best-practices-server

然后添加到你的 .vscode/mcp.json:

{
  "mcpServers": {
    "best-practices": {
      "command": "mcp-best-practices-server",
      "args": []
    }
  }
}

选项2：使用npx（推荐）

添加到您的 .vscode/mcp.json：

{
  "mcpServers": {
    "best-practices": {
      "command": "npx",
      "args": ["mcp-best-practices-server"]
    }
  }
}

✨ 特点

🔧 工具

📚 资源

直接浏览并访问最佳实践文档：

• TypeScript - 类型安全、现代语法、性能指南
• JavaScript（通常直接称为“JavaScript”，无需额外翻译） - ES6+，async/await，错误处理，安全性
• React - 组件设计、钩子（函数）、性能优化
• 通用编程 - SOLID原则，测试，文档编写

💬 提示

🎯 使用示例

在带有GitHub Copilot的VS Code中

获取特定语言的最佳实践

User: "Show me TypeScript best practices for error handling"
AI: *calls get_best_practices tool with language="typescript", category="error-handling"*

搜索特定指南

User: "How should I structure React components?"
AI: *calls search_best_practices tool with query="React component structure"*

代码审查与验证

User: "Review this function for best practices"

function getUserData(id) {
  const data = fetch('/api/users/' + id).then(r => r.json());
  return data;
}

AI: *calls validate_code_pattern tool to analyze the code*

使用内置提示

User: "/mcp.best-practices.code_review"
AI: *Prompts for code, language, and focus areas, then provides comprehensive review*

可用的最佳实践类别

• 演出 - 优化技术、缓存策略、懒加载
• 安全 - 输入验证、身份验证、授权、防止跨站脚本攻击（XSS）
• 测试 - 单元测试、集成测试、测试驱动开发（TDD）、模拟（mocking）
• 建筑 - 设计模式，SOLID原则，代码组织
• 可维护性 - 代码可读性、文档编写、重构

📖 支持的语言和框架

编程语言

• TypeScript - 现代TypeScript开发的完整指南
• JavaScript（一种编程语言） - ES6+ 最佳实践、异步模式、性能优化
• python - PEP 8（Python增强提案8），测试，打包（即将推出）
• Java - Spring Boot，测试，性能（即将推出）

框架和库

• React - 钩子（Hooks）、组件模式、性能优化
• Vue.js（发音类似“Vue 框架”，其中“Vue”可理解为“视图”或“视觉”的意思，但具体发音依据官方或社区习惯） - 组合API，响应式模式（即将推出）
• Express.js API设计、中间件、安全（即将推出）
• Next.js - SSR/SSG 模式，性能（即将推出）

🛠️ 开发

本地开发

1. 克隆仓库

   git clone https://github.com/yourusername/mcp-best-practices-server.git
   cd mcp-best-practices-server

1. 安装依赖项

   npm install

1. 构建项目

   npm run build

1. 在本地测试

   npm start

开发模式

对于需要自动重启的开发：

{
  "mcpServers": {
    "best-practices-dev": {
      "command": "node",
      "args": ["./dist/index.js"],
      "env": {
        "NODE_ENV": "development"
      },
      "dev": {
        "watch": ["src/**/*.ts", "best-practices/**/*.md"],
        "debug": {
          "type": "node",
          "request": "launch",
          "program": "./dist/index.js"
        }
      }
    }
  }
}

添加新的最佳实践

1. 在（指定位置）创建Markdown文件 best-practices/ 目录
2. 遵循命名规范： {language}/{framework}/{category}.md
3. 使用清晰的标题和代码示例
4. 包含正面和反面示例，并用✅/❌进行标注

示例结构：

best-practices/
├── typescript/
│   ├── general.md
│   ├── react/
│   │   ├── hooks.md
│   │   └── performance.md
│   └── testing.md
├── javascript/
│   ├── general.md
│   ├── async.md
│   └── security.md
└── general/
    ├── programming.md
    ├── testing.md
    └── architecture.md

🧪 测试

# Run all tests
npm test

# Run with coverage
npm run test:coverage

# Run linting
npm run lint

# Fix linting issues
npm run lint:fix

📚 API参考

工具模式（或工具架构）

获取最佳实践

interface GetBestPracticesArgs {
  language: string;           // Required: programming language
  framework?: string;         // Optional: specific framework
  category?: string;          // Optional: category like 'performance', 'security'
}

搜索最佳实践

interface SearchBestPracticesArgs {
  query: string;             // Required: search query
  limit?: number;            // Optional: max results (default: 10)
}

验证代码模式

interface ValidateCodePatternArgs {
  code: string;              // Required: code to analyze
  language: string;          // Required: programming language
  context?: string;          // Optional: additional context
}

🤝 贡献

我们欢迎投稿！以下是您能提供的帮助方式：

1. 添加新的最佳实践 - 提交新语言/框架的Markdown文件
2. 改进现有内容 - 完善当前最佳实践文档
3. 修复漏洞/错误 - 报告并修复服务器代码中的问题
4. 添加功能 - 实施新工具或功能

贡献指南

1. 为仓库创建分支（或：克隆仓库）
2. 创建一个特性分支（git checkout -b feature/amazing-feature)
3. 为新功能编写测试
4. 确保所有测试通过（npm test)
5. 根据需要更新文档
6. 提交更改（git commit -m 'Add amazing feature'）
7. 推送到分支（git push origin feature/amazing-feature)
8. 提交拉取请求

📄 许可证

这个项目采用MIT许可证授权——详见 许可证 文件中有详细信息。

🔗 相关项目

• 模型上下文协议 - 官方MCP规范
• MCP TypeScript SDK - 官方TypeScript SDK
• VS Code MCP 扩展 - VS Code MCP（可能指某种特定功能或插件）支持

📞 支持

• 问题：
• 讨论:
• 文档：

🌟 致谢

• MCP社区致力于创建一个令人惊叹的协议
• 那些分享了他们的知识和最佳实践的贡献者
• VS Code团队在MCP集成方面的卓越表现

______________________________________________________________________

为开发者社区倾心打造

*兼容VS Code、GitHub Copilot、Claude Desktop及其他MCP客户端*