FastMCP 使用教程

FastMCP 使用教程

fastmcp A TypeScript framework for building MCP servers. 项目地址: https://gitcode.com/gh_mirrors/fas/fastmcp

1. 项目介绍

FastMCP 是一个用 TypeScript 编写的框架，用于构建 MCP（Model Context Protocol）服务器。它能够处理客户端会话，并提供了一系列功能，如简单的工具、资源、提示定义，认证，会话管理，图片内容处理，日志记录，错误处理，服务器发送事件（SSE），跨源资源共享（CORS），进度通知，类型化服务器事件，提示参数自动补全，采样，自动 SSE 路由等。

2. 项目快速启动

首先，确保你已经安装了 Node.js 环境。然后按照以下步骤启动 FastMCP 项目：

# 克隆项目
git clone https://github.com/punkpeye/fastmcp.git

# 进入项目目录
cd fastmcp

# 安装依赖
npm install

# 启动服务器
# 这里假设你有一个名为 'addition.ts' 的示例服务器文件
npx fastmcp dev src/examples/addition.ts

上面的命令将启动一个简单的服务器，该服务器可以处理加法操作。你可以通过终端的 MCP Inspector 或其他 MCP 客户端来连接和测试服务器。

3. 应用案例和最佳实践

以下是一些使用 FastMCP 的应用案例和最佳实践：

定义和执行工具

import { FastMCP } from "fastmcp";
import { z } from "zod";

const server = new FastMCP({ name: "My Server", version: "1.0.0" });

server.addTool({
  name: "add",
  description: "Add two numbers",
  parameters: z.object({ a: z.number(), b: z.number() }),
  execute: async (args) => {
    return String(args.a + args.b);
  },
});

处理图片内容

import { imageContent } from "fastmcp";

server.addTool({
  name: "downloadImage",
  description: "Download an image",
  parameters: z.object({ url: z.string() }),
  execute: async (args) => {
    return imageContent({ url: args.url });
  },
});

日志记录和错误处理

import { UserError } from "fastmcp";

server.addTool({
  name: "downloadFile",
  description: "Download a file",
  parameters: z.object({ url: z.string() }),
  execute: async (args, { log }) => {
    log.info("Downloading file...", { url: args.url });
    // 模拟下载逻辑
    // ...
    log.info("Downloaded file");
    if (args.url.startsWith("https://example.com")) {
      throw new UserError("This URL is not allowed");
    }
    return "done";
  },
});

4. 典型生态项目

FastMCP 的生态项目包括但不限于：

• MCP Inspector：一个用于测试和调试 MCP 服务器的工具。
• Model Context Protocol SDK：客户端库，用于与 MCP 服务器通信。
• 其他开源项目：例如，使用 FastMCP 构建的各种服务，如聊天机器人、自动化工具等。

以上是 FastMCP 的基本使用教程。你可以根据具体需求，进一步探索和定制 FastMCP 项目的功能。

fastmcp A TypeScript framework for building MCP servers. 项目地址: https://gitcode.com/gh_mirrors/fas/fastmcp