MCP-Forge

MCP-Forge 是一个脚手架工具，旨在快速启动新的 MCP (模型上下文协议) 服务器项目。它生成一个结构良好的项目，其中包含样板代码、示例工具、资源和测试实用程序，使您可以专注于构建服务器的功能。

⚠️ 早期项目: 这是 MCP-Forge 的早期版本。随着 MCP 生态系统的发展，API、生成的结构和功能可能会发生变化。欢迎反馈和贡献！

支持开发

如果您觉得这个项目有用，请考虑捐款以支持其开发：

您的支持有助于维护和改进项目！

特性

• 为 MCP 服务器生成完整的 Python 项目结构。
• 包括用于 SSE 和 stdio 传输的单独服务器入口点。
• 提供示例 HelloWorld 工具和 HelloWorld/UserProfile 资源。
• 为清晰的输入/输出模式设置 Pydantic 模型。
• 包括一个基本的测试客户端 (test_client.py)，演示服务器交互。
• 使用 uv 进行依赖管理和任务运行。

安装

建议使用 uvx (来自 uv) 运行 mcp-forge，它可以处理临时环境：

# 确保已安装 uv
uvx mcp-forge --help

或者，您可以使用 pip 在全局或专用环境中安装它：

pip install mcp-forge
mcp-forge --help

用法

创建新的 MCP 服务器

主要命令是 new，它会搭建一个新的服务器项目。

# 使用 uvx 的示例 (推荐)
uvx mcp-forge new my-awesome-server

# 如果全局/在环境中安装的示例
# mcp-forge new my-awesome-server

此命令将：

1. 创建一个名为 my-awesome-server 的新目录。
2. 在此目录中生成完整的项目结构（见下文）。
3. 设置一个基本的服务器，其中包含可以运行的示例工具和资源。

new 命令的选项：

• --description 或 -d: 为您的项目提供自定义描述（用于 pyproject.toml 和 README.md）。

  uvx mcp-forge new my-project -d "My amazing MCP server"
  

• --python-version 或 -p: 指定所需的最低 Python 版本（默认值：>=3.10）。

  uvx mcp-forge new my-project -p ">=3.11"
  

生成的项目结构

MCP-Forge 创建一个具有以下结构的项目：

my-awesome-server/
├── my_awesome_server/           # 服务器代码的 Python 包
│   ├── __init__.py              # 包初始化
│   ├── server_stdio.py          # 使用 stdio 传输运行服务器的入口点
│   ├── server_sse.py            # 使用 SSE 传输 (HTTP) 运行服务器的入口点
│   ├── interfaces/              # 工具和资源的基本类/接口
│   │   ├── __init__.py
│   │   ├── resource.py
│   │   └── tool.py
│   ├── resources/               # 资源的实现
│   │   ├── __init__.py
│   │   ├── hello_world.py       # 示例静态资源
│   │   └── user_profile.py      # 带有 URI 参数的示例动态资源
│   ├── services/                # 用于管理工具和资源的服务
│   │   ├── __init__.py
│   │   ├── resource_service.py  # 处理资源注册和路由
│   │   └── tool_service.py      # 处理工具注册和执行
│   └── tools/                   # 工具的实现
│       ├── __init__.py
│       └── hello_world.py       # 带有输入/输出模式的示例工具
├── pyproject.toml               # 项目元数据和依赖项 (使用 Hatch)
├── test_client.py               # 用于测试服务器功能的示例客户端脚本
└── README.md                    # 生成项目的 README 模板

生成后的后续步骤

1. 导航到新创建的项目目录：

   cd my-awesome-server
   

2. 设置 Python 环境并安装依赖项：

   uv venv
   uv pip install -e .
   

3. 使用 SSE 或 stdio 运行服务器：

   # 运行 SSE 服务器 (默认: http://0.0.0.0:6969)
   uv run python -m my_awesome_server.server_sse
   
   # OR 运行 stdio 服务器
   # uv run python -m my_awesome_server.server_stdio
   

4. 在单独的终端中，运行测试客户端：

   # 确保您位于项目目录 (my-awesome-server) 中
   uv run test_client.py
   

关于 MCP

模型上下文协议 (MCP) 是一种规范，用于启用语言模型（或其他客户端）与外部工具/服务（服务器）之间的通信。它定义了服务器如何以标准化方式公开工具和资源等功能。

在官方 MCP 文档 中了解更多信息。

贡献

欢迎对 MCP-Forge 做出贡献！这是一个早期项目，因此有很大的改进空间和新功能。

1. Fork 存储库 (mcp-forge)
2. 创建您的功能分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开一个 Pull Request

许可证

此项目已获得 MIT 许可证的许可 - 有关详细信息，请参阅 LICENSE 文件（如果已生成）或源存储库。