关键词

脚手架MCP服务器生成项目模板Python服务端开发

使用说明

项目简介

MCP-Forge 是一个脚手架工具，旨在帮助开发者快速启动新的 MCP (Model Context Protocol) 服务器项目。它能够生成一个结构完善的项目，包含样板代码、示例工具、资源以及测试工具，让开发者可以专注于构建服务器的核心功能。

主要功能点

  • 快速生成项目结构: 自动创建包含必要目录和文件的 MCP 服务器项目框架。
  • 支持多种传输协议: 预置 SSE 和 stdio 两种服务器入口点，方便选择合适的通信方式。
  • 提供示例代码: 内置 'HelloWorld' 工具和 'HelloWorld'/'UserProfile' 资源作为参考和起点。
  • 规范数据模型: 集成 Pydantic，用于定义清晰的输入输出数据结构，提升代码可读性和维护性。
  • 包含测试客户端: 提供 'test_client.py' 示例，方便开发者快速测试服务器功能。

安装步骤

  1. 安装 MCP-Forge: 推荐使用 'uvx' 运行，或者使用 'pip' 进行全局或虚拟环境安装。 
    # 使用 uvx (推荐，确保已安装 uv)
uvx mcp-forge --help

# 或者使用 pip 安装
pip install mcp-forge
mcp-forge --help

服务器配置

MCP 服务器需要 MCP 客户端才能连接和使用。MCP 客户端需要配置服务器的启动命令 (command) 和参数 (args)。以下是针对使用 MCP-Forge 生成的服务器项目的配置示例 (JSON 格式)：

SSE 服务器配置示例 (默认端口: 6969):

{
  "serverName": "my-mcp-server-sse",
  "command": "uv",
  "args": ["run", "python", "-m", "my_mcp_server.server_sse"]
}

stdio 服务器配置示例:

{
  "serverName": "my-mcp-server-stdio",
  "command": "uv",
  "args": ["run", "python", "-m", "my_mcp_server.server_stdio"]
}

配置说明:

  • '"serverName"': 服务器名称，可以自定义。
  • '"command"': 启动服务器的命令，这里使用 'uv run python'。
  • '"args"': 传递给命令的参数，指定运行 Python 模块 'my_mcp_server.server_sse' 或 'my_mcp_server.server_stdio'。 请将 'my_mcp_server' 替换为您实际生成的项目包名 (项目名称中的 '-' 替换为 '_')。

重要提示: 以上配置假设您已在生成的项目根目录下执行了以下步骤：

  1. 'cd my-mcp-server' (进入您的项目目录)
  2. 'uv venv' (创建虚拟环境)
  3. 'uv pip install -e .' (安装项目依赖)

基本使用方法

  1. 创建新项目: 使用 'mcp-forge new <项目名称>' 命令生成新的 MCP 服务器项目。例如： 
    mcp-forge new my-mcp-server
  2. 进入项目目录: 'cd my-mcp-server'
  3. 配置并启动服务器: 按照上述 "服务器配置" 章节的说明，配置 MCP 客户端，并根据需要选择 SSE 或 stdio 服务器启动。 
    # 启动 SSE 服务器
uv run python -m my_mcp_server.server_sse

# 启动 stdio 服务器
uv run python -m my_mcp_server.server_stdio
  4. 测试服务器: 可以使用仓库自带的 'test_client.py' 进行基本测试，或者使用任何兼容 MCP 协议的客户端与服务器进行交互。

信息

分类

开发者工具

访问项目