@ai-partner/ai-partner-architecture
v0.1.0
Published
Architecture MCP Server for Cursor - 为 Cursor 终端大模型提供架构设计相关提示词的 MCP Server
Downloads
0
Maintainers
Readme
AI Partner Architecture MCP Server
为 Cursor 终端大模型提供系统架构设计相关提示词的 MCP Server。
🎯 功能概述
AI Partner Architecture MCP Server 是一个专门为 Cursor 终端大模型设计的 MCP (Model Context Protocol) 服务器,提供完整的系统架构设计文档编写支持。
核心功能
- 架构设计文档提示词获取:获取各种架构设计文档编写的专业提示词
- 架构设计项目初始化:初始化架构设计文档项目结构
- 架构设计文档编写指导:提供下一步编写建议和指导
- 架构设计文档生成:基于PRD需求自动生成架构设计文档
- 架构设计文档质量检查:对架构设计文档进行质量评估
- 架构设计文档总结报告:生成架构设计文档完成度分析报告
- 架构设计编写帮助指南:提供详细的编写指导和最佳实践
🛠️ 可用工具
1. architecture_document_prompt
获取系统架构设计文档编写的提示词。
参数说明:
filePath(必需):完整的文件路径,必须包含目录结构silent(可选):是否静默执行,默认为 true
常用路径示例:
.cursor/rules/architecture/design-methodology/architecture-system-design-thinking.mdc- 系统架构设计思考方法论.cursor/rules/architecture/templates/docs/template-architecture-system-design.mdc- 系统架构设计模板.cursor/rules/architecture/design-methodology/architecture-overview-design-thinking.mdc- 架构概述设计思考.cursor/rules/architecture/design-methodology/architecture-interface-design-thinking.mdc- 接口架构设计思考.cursor/rules/architecture/design-methodology/architecture-deployment-design-thinking.mdc- 部署架构设计思考
2. architecture_initialization
架构设计项目初始化工具,用于创建必要的目录结构和初始文档。
参数说明:
random_string(必需):Dummy parameter for no-parameter toolssilent(可选):是否静默执行,默认为 true
3. architecture_next_step
架构设计文档编写下一步指导工具,基于当前状态提供编写建议。
参数说明:
silent(可选):是否静默执行,默认为 true
4. architecture_generate_spec_doc
架构设计文档生成工具,基于PRD需求自动生成架构设计文档。
参数说明:
silent(可选):是否静默执行,默认为 true
5. architecture_quality_check
架构设计文档质量检查工具,对架构设计文档进行全面质量检查。
参数说明:
silent(可选):是否静默执行,默认为 true
6. architecture_summary_report
架构设计文档总结报告工具,生成架构设计文档的完成度分析报告。
参数说明:
silent(可选):是否静默执行,默认为 true
7. architecture_help_guide
架构设计文档编写帮助指南工具,提供详细的编写指导和最佳实践。
参数说明:
silent(可选):是否静默执行,默认为 true
📁 目录结构
.cursor/rules/architecture/
├── design-methodology/ # 设计思考方法论
│ ├── architecture-overview-design-thinking.mdc
│ ├── architecture-system-design-thinking.mdc
│ ├── architecture-interface-design-thinking.mdc
│ ├── architecture-deployment-design-thinking.mdc
│ ├── architecture-data-architecture-design-thinking.mdc
│ └── architecture-security-architecture-design-thinking.mdc
├── templates/ # 文档模板
│ └── docs/
│ ├── template-architecture-overview-chapter.mdc
│ ├── template-architecture-system-design.mdc
│ ├── template-architecture-tech-design.mdc
│ ├── template-architecture-data-design.mdc
│ ├── template-architecture-interface-design.mdc
│ ├── template-architecture-interface-module-design.mdc
│ ├── template-architecture-deployment-design.mdc
│ ├── template-architecture-security-design.mdc
│ └── template-architecture-other-chapters.mdc
├── architecture-design-methodology.mdc # 架构设计方法论总纲
├── architecture-design-thinking-methods.mdc # 架构设计思考方法
├── architecture-help-guide.mdc # 架构设计编写帮助指南
├── architecture-quality-check-report.mdc # 架构设计质量检查报告
├── architecture-progress-summary-report.mdc # 架构设计进度总结报告
└── architecture-initialization.mdc # 架构设计项目初始化🚀 快速开始
1. 安装依赖
cd AI-Partner-MCP-Architecture
npm install2. 配置Cursor
在 Cursor 的配置文件中添加 MCP 服务器配置:
{
"mcpServers": {
"ai-partner-architecture": {
"command": "node",
"args": ["/path/to/AI-Partner-MCP-Architecture/server.js"],
"env": {}
}
}
}3. 使用示例
获取架构设计文档提示词
使用 architecture_document_prompt 工具获取系统架构设计思考方法论
文件路径:.cursor/rules/architecture/design-methodology/architecture-system-design-thinking.mdc初始化架构设计项目
使用 architecture_initialization 工具初始化架构设计项目生成架构设计文档
使用 architecture_generate_spec_doc 工具生成架构设计文档📋 架构设计文档结构
标准的系统架构设计文档包含以下章节:
第1章 架构概述
- 1.1 系统背景
- 1.2 架构目标
- 1.3 架构范围
- 1.4 术语定义
- 1.5 参考文档
第2章 系统架构设计
- 2.1 技术架构设计
- 2.2 数据架构设计
- 2.3 整体架构逻辑
第3章 接口架构设计
- 3.1 接口模块列表
- 3.2.X 具体接口设计
- 3.2.X.1 接口设计
- 3.2.X.2 接口字段说明
- 3.2.X.3 接口操作说明
- 3.2.X.4 接口状态图
- 3.2.X.5 处理逻辑详细说明
第4章 部署架构设计
- 4.1 部署架构概述
- 4.2 部署环境要求
- 4.3 部署配置说明
- 4.4 部署流程说明
🎯 设计方法论
本 MCP Server 基于以下设计方法论:
架构驱动的设计思维
- 架构优先原则:所有架构设计必须基于系统整体架构
- 系统驱动机制:每个架构组件都有明确的系统需求依据
- 技术价值导向原则:确保每个架构组件都创造技术价值
架构完整性评估驱动的设计策略
- 智能完整性识别:从多个维度评估架构完整性
- 分层设计策略:根据复杂度采用不同的设计策略
- 设计适配原则:架构设计深度与系统业务复杂度匹配
系统架构为中心的设计
- 架构优先:从系统整体架构设计组件关系
- 完整系统视图:设计完整的系统架构视图
- 价值创造验证:验证每个设计的架构组件是否为系统创造独立的技术价值
- 业务无关原则:将业务实现细节从架构设计中剥离
🔧 开发指南
环境要求
- Node.js >= 16.0.0
- npm >= 8.0.0
开发命令
# 安装依赖
npm install
# 开发模式运行
npm run dev
# 生产模式运行
npm start
# 运行测试
npm test配置说明
mcp-server.json:MCP服务器配置文件server.js:主服务器文件package.json:项目依赖和脚本配置
📝 更新日志
v0.1.0 (2025-01-20)
- 初始版本发布
- 支持架构设计文档生成
- 支持架构设计质量检查
- 支持架构设计总结报告
🤝 贡献指南
欢迎提交 Issue 和 Pull Request 来改进这个项目。
📄 许可证
MIT License
