mcp-server-starter MCP 服务说明文档

📅 2026/8/15 13:19:38
mcp-server-starter MCP 服务说明文档
1. 服务概述一句话简介Python MCP服务器构建骨架模板用于快速开发自定义MCP服务器并暴露自定义工具和数据源服务名称mcp-server-starter版本号最新版本通过GitHub发布开发者/提供方roderickch01协议类型MCP (Model Context Protocol)2. 核心功能该MCP服务提供以下主要功能2.1 演示工具echo(text: str) - str返回echo: {text}用于验证基本连接add(a: int, b: int) - int返回两个整数的和用于验证参数传递2.2 开发框架功能装饰器工具注册使用mcp.tool()装饰器快速添加自定义工具自动模式生成从函数签名、类型提示和文档字符串自动生成工具模式标准协议支持完全支持MCP协议的工具发现和调用机制简洁代码结构核心代码少于30行易于理解和扩展3. 使用场景该服务适合在以下情况下使用快速原型开发快速构建自定义MCP服务器原型验证想法和概念自定义工具集成为Claude Desktop、Claude Code等客户端暴露自定义工具和数据源学习MCP开发作为学习MCP服务器开发的起点理解协议和工具注册机制企业内部工具构建企业内部使用的MCP服务器暴露内部API和数据源数据处理管道创建专门的数据处理和转换工具供AI助手调用4. 接入方式4.1 服务端点该服务通过标准输入输出stdio运行通信方式stdio标准输入输出协议MCP (Model Context Protocol)运行环境Python虚拟环境或pipx隔离环境4.2 认证与权限该服务不需要特殊认证本地运行无需API密钥权限取决于运行用户的环境权限适合开发和测试环境使用4.3 数据格式服务使用以下数据格式输入参数JSON格式通过MCP协议传递输出结果JSON格式通过MCP协议返回类型系统基于Python类型提示4.4 服务器配置在MCP客户端配置中添加服务{ mcpServers: { starter: { command: mcp-server-starter } } }5. 接口定义工具名称功能描述参数说明返回值echo返回输入文本的回显text: str - 输入文本str - echo: {text}add计算两个整数的和a: int - 第一个整数b: int - 第二个整数int - 两数之和6. 快速开始6.1 环境要求Python 3.8或更高版本pipx推荐或pip包管理器Git用于从GitHub安装6.2 安装步骤方法1使用pipx安装推荐pipx install githttps://github.com/roderickch01/mcp-server-starter.git方法2本地开发安装git clone https://github.com/roderickch01/mcp-server-starter.git cd mcp-server-starter python -m venv .venv source .venv/bin/activate # Linux/macOS # 或 .venv\Scripts\activate # Windows pip install -e . mcp-server-starter6.3 配置Claude DesktopLinux编辑 ~/.config/Claude/claude_desktop_config.jsonmacOS编辑 ~/Library/Application Support/Claude/claude_desktop_config.jsonWindows编辑 %APPDATA%\Claude\claude_desktop_config.json添加以下配置{ mcpServers: { starter: { command: mcp-server-starter } } }6.4 添加自定义工具打开src/mcp_server_starter/server.py文件使用装饰器添加新工具mcp.tool() def reverse(text: str) - str: Return the input string reversed. return text[::-1]重新安装并重启客户端pipx reinstall mcp-server-starter6.5 使用示例示例1使用echo工具 用户echo Hello, MCP! 返回echo: Hello, MCP! 示例2使用add工具 用户add 15 27 返回42 示例3自定义reverse工具 用户reverse Python 返回nohtyP7. 注意事项重要提醒重新安装添加新工具后需要重新安装pipx reinstall并重启MCP客户端类型提示必须为函数参数和返回值添加类型提示MCP使用这些信息生成工具模式文档字符串为工具函数添加文档字符串这将成为工具的描述信息开发建议虚拟环境本地开发时使用虚拟环境避免污染系统Python环境代码简洁核心代码少于30行保持简洁易读测试验证添加工具后立即测试确保工具正确注册和调用错误处理为工具函数添加适当的错误处理提高健壮性架构说明┌─────────────────┐ │ MCP Client │ │ (Claude Desktop)│ └────────┬────────┘ │ stdio (MCP) ▼ ┌─────────────────┐ │ mcp-server- │ │ starter │ │ (Python) │ └─────────────────┘ │ ▼ ┌─────────────────┐ │ Custom Tools │ │ (echo, add, ...)│ └─────────────────┘扩展方向添加资源使用mcp.resource()装饰器暴露数据资源添加提示使用mcp.prompt()装饰器定义提示模板外部API集成在工具函数中调用外部API扩展功能范围数据库访问添加数据库查询工具暴露数据访问能力总结mcp-server-starter是一个极简的Python MCP服务器模板提供了快速构建自定义MCP服务器所需的基础设施。通过装饰器和类型提示开发者可以轻松添加自定义工具而无需深入了解MCP协议细节。这是学习和开发MCP服务器的理想起点特别适合快速原型开发和自定义工具集成。