Boilerplate Python MCP Server

MCP服务器Python项目模板

A. 厨师切菜机 用于在Python中创建模型上下文协议（MCP）服务器的模板。

特性

• 🚀 快速设置：使用合理的默认值快速构建一个完整的Python MCP服务器。
• 📦 现代包装管理：用途 紫外线 用于快速依赖管理。
• 🏢 Nexus发布就绪：简化了对打包和发布到公司私有Nexus存储库的支持。
• 🐳 集装箱友好：包括a Dockerfile 易于构建和部署Docker镜像。

先决条件

• Python>=3.11
• 厨师切菜机
• 紫外线 （推荐）

快速启动

1.安装先决条件

厨师切菜机

# Using pipx (recommended)
pipx install cookiecutter

# Or using pip
pip install cookiecutter

紫外线

# Using the installer script for macOS and Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

2.生成您的项目

您可以通过多种方式从该模板生成新的MCP服务器项目。

选项1：来自GitHub（推荐）

cookiecutter git@github.com:AfterShip/boilerplate-python-mcp-server \
  project_name="Your project name" \
  author_name="Your name" \
  author_email="Your email" \
  --no-input \
  --output-dir "Your output directory"

选项2：从本地克隆

# Clone this template repository
git clone git@github.com:AfterShip/boilerplate-python-mcp-server.git

cd boilerplate-python-mcp-server

cookiecutter . \
  project_name="your_project_name" \
  author_name="your_name" \
  author_email="your_email" \
  --no-input \
  --output-dir "your_output_directory"

就是这样！现在，您已经准备好开始开发自定义MCP服务器了。

配置选项

生成项目时，系统将提示您输入以下信息（除非您使用 --no-input):

接下来会发生什么？

跑步之后 cookiecutter一 post_gen_project.py hook脚本会在新创建的项目目录中自动为您执行以下步骤：

1. 初始化Git存储库: git init
2. 安装依赖项: uv sync --dev
3. 创建初始提交: git add . && git commit -m "Initial commit"

开发您的MCP服务器

您生成的项目包括它自己的 README.md 包含服务器开发、测试和运行的详细说明。

以下是一些快速命令（从新项目的目录运行）：

# Run the server (defaults to stdio transport)
uv run your_package_name

# Run tests
uv run pytest

请参阅 README.md 在你的新项目中了解更多细节。

自定义此模板

您可以分叉此存储库并根据需要进行自定义：

1. 修改默认值：编辑 cookiecutter.json 文件。
2. 添加或删除文件：在中添加/删除文件 {{cookiecutter.project_slug}}/ 目录。
3. 更改文件内容：编辑模板文件。他们使用 Jinja2 模板语法。

Jinja2语法示例：

{% if cookiecutter.include_docker == 'y' -%}
# This content will only be included if the user chooses to include Docker support.
{% endif -%}

Project Name: {{ cookiecutter.project_name }}

贡献

欢迎为改进此模板做出贡献！请随时提交问题和拉取请求。