article
README
🚀 编码标准 MCP 服务器
此 MCP 服务器为 Java、Python、React 等多种技术提供了访问编码风格指南和最佳实践的工具,帮助开发者遵循统一规范,提升代码质量。
🚀 快速开始
先决条件
- Python 3.8 或更高版本
- MCP 包(
pip install mcp) - UV 包管理器(推荐)
操作步骤
- 在 Claude 中安装服务器:
mcp install server.py
- 在开发模式下运行:
mcp dev server.py
MCP 检查员将在端口 3000 上启动。
✨ 可用工具
风格指南
可访问特定语言的编码风格指南:
- Java:涵盖清洁代码实践、命名约定、代码组织等方面。
- Python:基于 PEP 8 的指南以及 Pythonic 代码实践。
- React:涉及组件结构、钩子使用、TypeScript 集成等内容。
最佳实践
能访问特定语言的应用程序最佳实践:
- Java:包含项目结构、架构、测试、安全等方面。
- Python:有项目布局、依赖管理、测试实践等内容。
- React:涉及组件模式、状态管理、性能优化等方面。
📚 API 参考
java_style_guide:获取 Java 编码风格指南- 返回:Markdown 格式化样式指南
- 示例:
nortal_coding_standards_java_style_guide()
java_best_practices:获取 Java 应用程序最佳实践- 返回:Markdown 格式化最佳实践
- 示例:
nortal_coding_standards_java_best_practices()
python_style_guide:获取 Python 编码风格指南- 返回:Markdown 格式化样式指南
- 示例:
nortal_coding_standards_python_style_guide()
python_best_practices:获取 Python 应用程序最佳实践- 返回:Markdown 格式化最佳实践
- 示例:
nortal_coding_standards_python_best_practices()
react_best_practices:获取 React 应用程序最佳实践- 返回:Markdown 格式化最佳实践
- 示例:
nortal_coding_standards_react_best_practices()
🔧 配置
MCP 客户端配置
将以下内容添加到您的 MCP 客户端配置文件中(例如 ~/.codeium/windsurf/mcp_config.json):
{
"mcpServers": {
"nortal_coding_standards": {
"command": "uv",
"args": [
"run",
"--with",
"mcp[cli]",
"mcp",
"run",
"/absolute/path/to/coding-standards-mcp/server.py"
]
}
}
}
请将 /absolute/path/to/coding-standards-mcp/server.py 替换为您实际的服务器路径。
微信扫一扫