Project Orchestrator

🚀 MCP 项目 orchestrator

MCP 项目 orchestrator 是一个全面的项目编排工具，可用于管理 Model Context Protocol (MCP) 项目的模板、提示和 Mermaid 图形，极大提升项目管理效率。

🚀 快速开始

项目模板

from mcp_project_orchestrator.templates import TemplateManager

# 初始化模板管理器
manager = TemplateManager("path/to/templates")

# 列出可用的模板
templates = manager.list_templates()
print(templates)

# 应用一个项目模板
manager.apply_template("fastapi-project", {
    "project_name": "my-api",
    "project_description": "My FastAPI project",
    "author_name": "John Doe",
    "author_email": "john@example.com"
})

提示管理

from mcp_project_orchestrator.prompts import PromptManager

# 初始化提示管理器
manager = PromptManager("path/to/prompts")

# 列出可用的提示
prompts = manager.list_prompts()
print(prompts)

# 使用变量渲染提示
rendered = manager.render_prompt("system-prompt", {
    "name": "User",
    "project": "MCP"
})
print(rendered)

Mermaid 图形

from mcp_project_orchestrator.mermaid import MermaidGenerator, MermaidRenderer

# 初始化生成器
generator = MermaidGenerator()
renderer = MermaidRenderer()

# 生成流程图
flowchart = generator.generate_flowchart(
    nodes=[
        ("A", "Start"),
        ("B", "Process"),
        ("C", "End")
    ],
    edges=[
        ("A", "B", ""),
        ("B", "C", "")
    ]
)

# 渲染为 SVG
renderer.render(flowchart, "flowchart.svg")

✨ 主要特性

• 模板管理
  • 提供项目模板，可快速设置项目。
  • 具备组件模板，支持模块化开发。
  • 支持变量替换和验证。
  • 实现模板发现和版本控制。
• 提示管理
  • 包含系统提示和用户提示模板。
  • 支持变量替换。
  • 实现提示分类和版本控制，便于发现和重用提示。
• Mermaid 图形生成
  • 可生成流程图、时序图和类图。
  • 支持 SVG 和 PNG 渲染。
  • 具备图形验证功能。

📦 安装指南

pip install mcp-project-orchestrator

或使用 Poetry：

poetry add mcp-project-orchestrator

💻 使用示例

基础用法

以下是使用项目模板、提示管理和 Mermaid 图形生成的基础代码示例：

# 项目模板使用示例
from mcp_project_orchestrator.templates import TemplateManager

manager = TemplateManager("path/to/templates")
templates = manager.list_templates()
print(templates)
manager.apply_template("fastapi-project", {
    "project_name": "my-api",
    "project_description": "My FastAPI project",
    "author_name": "John Doe",
    "author_email": "john@example.com"
})

# 提示管理使用示例
from mcp_project_orchestrator.prompts import PromptManager

manager = PromptManager("path/to/prompts")
prompts = manager.list_prompts()
print(prompts)
rendered = manager.render_prompt("system-prompt", {
    "name": "User",
    "project": "MCP"
})
print(rendered)

# Mermaid 图形生成使用示例
from mcp_project_orchestrator.mermaid import MermaidGenerator, MermaidRenderer

generator = MermaidGenerator()
renderer = MermaidRenderer()
flowchart = generator.generate_flowchart(
    nodes=[
        ("A", "Start"),
        ("B", "Process"),
        ("C", "End")
    ],
    edges=[
        ("A", "B", ""),
        ("B", "C", "")
    ]
)
renderer.render(flowchart, "flowchart.svg")

高级用法

暂未提供高级用法示例，可根据实际需求对基础用法进行扩展。

📚 详细文档

项目结构

mcp-project-orchestrator/
├── src/
│   └── mcp_project_orchestrator/
│       ├── templates/
│       │   ├── __init__.py
│       │   ├── base.py
│       │   └── specific_template.py
│       ├── prompts/
│       │   ├── __init__.py
│       │   ├── system_prompt.py
│       │   └── user_prompt.py
│       └── mermaid/
│           ├── __init__.py
│           ├── flowchart.py
│           └── sequence_diagram.py
├── tests/
│   ├── test_templates.py
│   ├── test_prompts.py
│   └── test_mermaid.py
└── README.md

贡献指南

1. 创建功能分支
2. 提交代码更改
3. 推动到分支
4. 创建 Pull Request

📄 许可证

此项目在 MIT License 下许可 - 有关详细信息，请参阅 LICENSE 文件。

致谢

• Model Context Protocol - 此项目的基石
• Mermaid - 用于图形生成
• Poetry - 用于依赖管理
• Ruff - 用于代码格式检查