JinDaGe - mcp-forge MCP Details

article

README

🚀 MCP-Forge

MCP-Forge 是一款脚手架工具，可用于快速搭建新的 MCP（模型上下文协议）服务器项目。它会生成一个结构良好的项目，其中包含示例工具、资源和测试工具，让您能够专注于服务器功能的构建。

🚀 快速开始

MCP-Forge 能帮助您迅速开启 MCP 服务器项目的搭建。以下为您详细介绍使用步骤。

创建新项目

要创建一个新的 MCP 服务器项目，请运行以下命令：

mcp-forge new my-awesome-server
cd my-awesome-server

启动服务器

要启动服务器，请执行以下命令：

uv run python -m my_awesome_server.server --mode=sse

或者，如果您已进入项目目录：

my-awesome-server --mode=sse  # 在 SSE 模式下运行（HTTP 服务在 0.0.0.0:6969）
my-awesome-server --mode=stdio # 在 stdio 模式下运行

✨ 主要特性

生成完整的 Python 项目结构，专门用于 MCP 服务器。
提供统一的服务器入口点，并可通过 --mode 参数选择 SSE 和 stdio 传输模式。
包含示例工具（如 AddNumbers、DateDifference 等）和资源（如 HelloWorld、UserProfile）。
使用 Pydantic 模型定义清晰的输入/输出架构。
使用 uv 进行依赖管理及任务运行。

📦 安装指南

推荐使用 uvx（来自 uv），它能处理临时环境：

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

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

pip install mcp-forge
mcp-forge --help

📚 详细文档

项目结构

生成的项目结构如下：

my_awesome_server/
├── server.py             # 主服务器文件
├── tools/               # 自定义工具目录
│   └── __init__.py      # 工具初始化文件
├── resources/           # 资源目录
│   └── __init__.py      # 资源初始化文件
└── requirements.txt     # 项目依赖管理文件

关于 MCP

模型上下文协议（MCP）是一项规范，用于实现语言模型（或其他客户端）与外部工具/服务（服务器）之间的通信。它定义了服务器如何以标准方式暴露工具和资源。了解更多信息，请访问 MCP 官方文档。

支持开发

如果您发现此项目有用，请考虑通过捐赠支持其开发：您的支持将有助于维护和改进该项目！

贡献

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

分叉仓库（mcp-forge）
创建功能分支（git checkout -b feature/amazing-feature）
提交更改（git commit -m '添加一些很棒的功能'）
推送到分支（git push origin feature/amazing-feature）
打开 Pull Request

📄 许可证

该项目在 MIT 许可证下开源。有关详细信息，请查看生成的 LICENSE 文件或源仓库。

⚠️ 重要提示

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

mcp-forge