MCP服务器模板

这是一个基于fastmcp库的Python MCP服务器模板,专为VS Code与GitHub Copilot优化,用于快速构建和部署MCP服务器。

  • by olohmann
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 olohmann/template-python-mcp-server

使用说明

自述

这是Python的模板 主控程序 (模型上下文协议)服务器基于 fastmcp 图书馆。它针对GitHub Copilot的VS代码设置进行了优化。

入门指南

要开始使用此模板,请克隆存储库并替换所有出现的 TODO-TEMPLATE 使用您自己的价值观,并开始在中实现您的MCP服务器 服务器.py.

# Shallow clone the repository
git clone --depth 1 --single-branch https://github.com/olohmann/template-python-mcp-server.git my-mcp-server
# Change into the project directory
cd my-mcp-server
# Remove the .git directory to start fresh
rm -rf .git
# Initialize a new git repository
git init

# Find all TODO-TEMPLATE occurrences in the repository and replace them
# First, see what will be changed
grep -rn "TODO-TEMPLATE" . --exclude=README.md
# Then replace automatically in all files
grep -rl "YEAR-TODO-TEMPLATE" . --exclude=README.md | xargs sed -i '' 's/YEAR-TODO-TEMPLATE/2025/g'
grep -rl "AUTHOR-TODO-TEMPLATE" . --exclude=README.md | xargs sed -i '' 's/YEAR-TODO-TEMPLATE/Name/g'
grep -rl "TODO-TEMPLATE" . --exclude=README.md | xargs sed -i '' 's/TODO-TEMPLATE/my-mcp-server/g'

# Finally, update the README.md
vi README.md

文件结构

文件/目录 目的
server.py 使用FastMCP和示例工具实现主MCP服务器
pyproject.toml 项目配置、依赖关系和工具设置(Ruff)
uv.lock 可复制构建的锁定依赖版本
Dockerfile 部署容器配置
README.md 项目文件和使用说明
LICENSE MIT许可证文件
.gitignore Git忽略Python项目的模式
.editorconfig 跨编辑器代码格式配置
.github/ GitHub特定的配置和工作流程
└── copilot-instructions.md GitHub Copilot的编码指南
└── workflows/ GitHub操作CI/CD工作流
.vscode/ VS代码工作区配置
└── settings.json VS代码编辑器设置
└── tasks.json VS代码构建和测试任务
└── extensions.json 推荐的VS代码扩展名

管理依赖关系

此模板使用 紫外线 管理依赖关系。

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。