项目简介

'fastmcp-boilerplate' 是一个用于构建 MCP 服务器的样板项目，基于 'fastmcp' 库。它提供了一个基础的 MCP 服务器结构，包含示例的工具、资源和提示模板定义，并集成了开发常用的测试、代码检查和格式化流程。

主要功能点

• 工具注册与执行: 示例展示如何注册一个简单的加法工具 ('add')，并定义其输入参数和执行逻辑。LLM 客户端可以通过 MCP 协议调用此工具。
• 资源托管与访问: 示例展示如何定义一个名为 "Application Logs" 的资源，并提供加载其内容的方法。LLM 客户端可以请求读取此资源内容。
• 提示模板定义: 示例展示如何定义一个名为 "git-commit" 的提示模板，用于生成 Git 提交信息，并定义其所需的输入参数。LLM 客户端可以获取并使用此模板。
• 基础服务启动: 配置服务器通过 Stdio 传输协议启动，方便与 MCP 客户端通信。

安装步骤

1. 克隆仓库：'git clone https://github.com/punkpeye/fastmcp-boilerplate.git'
2. 进入目录：'cd fastmcp-boilerplate'
3. 安装依赖：'npm install'
4. 启动开发服务器：'npm run dev' (服务器将通过标准输入输出运行)

服务器配置 (供MCP客户端使用)

MCP客户端需要知道如何启动这个MCP服务器进程。以下是示例配置信息：

{
  "name": "Addition", // MCP服务器在客户端中显示的名称，与服务器代码中定义的名称一致
  "command": "npm",   // 启动MCP服务器进程的命令
  "args": ["run", "dev"] // 传递给命令的参数，这里是运行 package.json 中的 dev 脚本来启动服务器
  // 可以根据需要添加其他可选字段，例如：
  // "cwd": "/path/to/your/server/directory" // MCP服务器进程的工作目录
  // "env": { "NODE_ENV": "development" } // 为MCP服务器进程设置环境变量
  // "transport": "stdio" // 指定使用的传输协议，例如 stdio, sse, websocket 等 (通常 stdio 是默认且最简单的)
}

客户端使用这个配置来启动MCP服务器进程，并通过配置指定的传输协议（如标准输入/输出）与之建立连接并通信。

基本使用方法

启动服务器后 (例如使用 'npm run dev')，它会监听标准输入输出。一个符合 MCP 协议的客户端可以通过标准输入向服务器发送 JSON-RPC 请求（例如调用 'add' 工具、读取 'Application Logs' 资源、获取 'git-commit' 提示模板内容），服务器将通过标准输出返回 JSON-RPC 响应或通知。这是一个基于命令行的交互模式示例。在实际应用中，通常是支持 MCP 协议的 LLM 客户端（如 AI 开发环境、定制化聊天应用等）自动与服务器进行通信。