Litemcp

🚀 LiteMCP 中文文檔

LiteMCP 是一個 TypeScript 框架，可用於優雅地構建 MCP（模型上下文協議）服務器，為開發者提供便捷高效的開發體驗。

⚠️ 重要提示

由於官方 SDK 已經提供了與本項目類似的高級別 API，因此該項目將不再維護。

如果你喜歡此項目中的 CLI 命令，請獨立使用它們：https://github.com/wong2/mcp-cli

✨ 主要特性

• 支持簡單工具、資源、提示定義。
• 提供完整的 TypeScript 支持。
• 內置 日誌記錄 功能。
• 具備內置錯誤處理機制。
• 內置 CLI 用於 測試和調試。
• 內置對 SSE 傳輸 的支持。

📦 安裝指南

npm install litemcp zod

🚀 快速開始

import { LiteMCP } from "litemcp";
import { z } from "zod";

const server = new LiteMCP("demo", "1.0.0");

server.addTool({
  name: "add",
  description: "添加兩個數字",
  parameters: z.object({
    a: z.number(),
    b: z.number(),
  }),
  execute: async (args) => {
    return args.a + args.b;
  },
});

server.addResource({
  name: "resource-example",
  description: "這是一個示例資源",
  content: "Hello, World!",
});

server.start();

運行以下命令以測試服務器：

node server.js

📚 詳細文檔

核心概念

工具（Tools）

工具是定義可以執行操作的函數。例如，一個簡單的計算器工具。

server.addTool({
  name: "calculator",
  description: "A simple calculator",
  parameters: z.object({
    a: z.number(),
    b: z.number(),
  }),
  async execute(args) {
    return { 
      add: args.a + args.b,
      subtract: args.a - args.b
    };
  },
});

資源（Resources）

資源表示可以訪問的靜態內容或動態生成的內容。

server.addResource({
  name: "static-resource",
  description: "A static resource example",
  content: "This is a static resource.",
});

server.addDynamicResource(async () => {
  return {
    name: "dynamic-resource",
    description: "A dynamic resource example",
    content: await fetch('https://api.example.com/data'),
  };
});

提示（Prompts）

提示用於定義交互式對話流程。

server.addPrompt({
  name: "greeting-prompt",
  description: "A simple greeting prompt",
  async execute() {
    const name = await server.prompt("請輸入你的名字：");
    return `你好，${name}！`;
  },
});

日誌記錄（Logging）

LiteMCP 提供了內置的日誌記錄功能。

server.log("信息日誌");
server.debug("調試日誌");
server.error("錯誤日誌");

運行你的服務器

啟動服務器

默認情況下，服務器使用 stdio 傳輸：

server.start();

你也可以指定自定義端口和其他選項：

server.start({
  port: 3000,
  hostname: 'localhost',
});

調試和日誌記錄

你可以通過以下命令進行調試：

node server.js --inspect

同時，LiteMCP 提供了內置的調試功能：

server.debug("調試信息");

SSE 傳輸

服務器默認運行 stdio 傳輸。你也可以使用 SSE 模式：

server.start({
  transportType: "sse",
  sse: {
    endpoint: "/sse",
    port: 8080,
  },
});

這將啟動服務器並在 http://localhost:8080/sse 監聽 SSE 連接。

展示

如果你使用 LiteMCP 開發了服務器，請通過提交 PR 的方式展示在這裡！

• https://github.com/wong2/mcp-jina-reader
• https://github.com/nloui/paperless-mcp

發展計劃

• 添加對資源模板的支持

相關項目

• mcp-cli - 用於測試和調試 MCP 服務器的 CLI
• mcpservers.org - 精選的 MCP 服務器列表
• FastMCP - 一個用於 MCP 服務器開發的 Python 庫，本項目的靈感來源