Fastmcp

🚀 FastMCP 快速入門指南

FastMCP 是一個用於快速開發 MCP（模型上下文協議）服務器的 TypeScript 框架。它簡化了與各種 LLM 的集成，通過直觀的 API 和中間件系統，讓開發者能快速構建自定義 MCP 服務，還支持多種高級功能。

🚀 快速開始

安裝依賴項

npm install fastmcp --save

創建項目結構

your-project/
├── package.json
├── tsconfig.json
└── src/
    └── server.ts

初始化配置

在 tsconfig.json 中添加以下內容以啟用 TypeScript 支持：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "CommonJS"
  }
}

運行服務器

ts-node src/server.ts

✨ 主要特性

• 簡單易用：通過直觀的 API 和中間件系統快速構建自定義 MCP 服務。
• 高性能：內置高效的請求處理機制，確保低延遲和高吞吐量。
• 可擴展性：支持插件系統，允許輕鬆添加自定義功能。
• 跨平臺兼容性：支持多種操作系統和環境。

📦 安裝指南

要開始使用 FastMCP，請按照以下步驟進行安裝：

步驟 1：通過 npm 安裝 FastMCP

npm install fastmcp --save

步驟 2：創建 server.ts 文件並添加代碼

import { createServer } from 'fastmcp';

const server = createServer();

// 添加自定義路由
server.get('/ping', (req, res) => {
  res.send('pong');
});

server.start(3000);

步驟 3：運行服務器

ts-node server.ts

💻 使用示例

基礎用法

以下是一個簡單的示例，展示瞭如何創建一個基本的 MCP 服務器：

import { createServer } from 'fastmcp';

const server = createServer();

// 處理根路徑請求
server.get('/', (req, res) => {
  res.send('Welcome to FastMCP Server!');
});

// 啟動服務器
server.start(3000);

高級用法

中間件示例

import { createServer, Middleware } from 'fastmcp';

const server = createServer();

// 創建一個簡單的中間件
const loggerMiddleware: Middleware = (req, res, next) => {
  console.log('請求開始:', req.url);
  next();
};

// 將中間件應用到所有請求
server.use(loggerMiddleware);

server.get('/', (req, res) => {
  res.send('Hello World!');
});

server.start(3000);

路由示例

import { createServer } from 'fastmcp';

const server = createServer();

// 定義路由處理不同請求類型
server.get('/api/data', (req, res) => {
  // 返回 JSON 數據
  res.json({ message: '數據獲取成功!' });
});

server.post('/api/upload', async (req, res) => {
  // 處理文件上傳
  const uploadedFile = await req.file();
  res.send(`文件 ${uploadedFile.name} 成功上傳！`);
});

server.start(3001);

📚 詳細文檔

FastMCP 提供了詳細的文檔和示例，幫助你快速上手並掌握高級功能。訪問 FastMCP 官方網站 查看完整文檔。

API 參考

Server 類

• start(port: number)：啟動服務器，指定要監聽的端口。
• get(path: string, handler: (req, res) => void)：添加一個新的 GET 路由。
• post(path: string, handler: (req, res) => void)：添加一個新的 POST 路由。

Middleware

• 類型定義：

type Middleware = (
  req: Request,
  res: Response,
  next: () => void
) => void;

開發指南

創建自定義中間件

FastMCP 允許你創建自定義中間件來擴展服務器功能：

import { createServer, Middleware } from 'fastmcp';

const server = createServer();

// 自定義日誌記錄中間件
const logger: Middleware = (req, res, next) => {
  console.log(`收到請求：${req.method} ${req.url}`);
  next();
};

server.use(logger);

server.get('/', (req, res) => {
  res.send('Hello World!');
});

server.start(3002);

使用插件

FastMCP 的插件系統允許你快速擴展服務器功能。例如，添加身份驗證、日誌記錄等：

import { createServer } from 'fastmcp';
import { cors } from 'fastmcp/plugins/cors';

const server = createServer();

// 啟用 CORS 插件
server.use(cors());

server.get('/api/test', (req, res) => {
  res.send('CORS 已啟用!');
});

server.start(3003);

常見問題

如何處理錯誤？

你可以使用中間件來捕獲和處理錯誤：

import { createServer, Middleware } from 'fastmcp';

const server = createServer();

// 錯誤處理中間件
const errorHandler: Middleware = (req, res, next) => {
  try {
    next();
  } catch (err) {
    console.error('發生錯誤:', err);
    res.status(500).send('服務器內部錯誤');
  }
};

server.use(errorHandler);

server.get('/test/error', () => {
  throw new Error('測試錯誤處理');
});

server.start(3004);

其他資源

• GitHub 倉庫：fastmcp/fastmcp
• Discord 社區：加入 FastMCP 討論群 獲取支持和交流。
• 開發者博客：閱讀 FastMCP 開發日誌 瞭解最新動態。

通過 FastMCP，你可以快速構建高效、可靠且易於擴展的 MCP 服務器。開始你的項目吧！