Github Gists

🚀 MCP TypeScript SDK

本 SDK 使用 TypeScript 實現了 Model Context Protocol (MCP)，具備完整的客戶端和服務端功能，能輕鬆集成到大語言模型（LLM）的交互界面中，為應用與 LLM 的交互提供便利。

🚀 快速開始

Model Context Protocol 支持應用程序以標準化方式為 LLM 提供上下文信息，將上下文提供與實際的 LLM 交互解耦。此 TypeScript SDK 實現了完整的 MCP 標準規範，具備以下優勢：

• 可構建能連接到任何 MCP 服務端的客戶端。
• 能創建暴露資源、提示和工具的 MCP 服務端。
• 支持使用標準傳輸方式，如 stdio 和 SSE。
• 可處理所有 MCP 協議消息和生命週期事件。

📦 安裝指南

使用以下命令進行安裝：

npm install @modelcontextprotocol/sdk

💻 使用示例

基礎用法

創建客戶端

import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";

const transport = new StdioClientTransport({
  command: "path/to/server",
});

const client = new Client({
  name: "example-client",
  version: "1.0.0",
}, {
  capabilities: {}
});

await client.connect(transport);

// 列出可用資源
const resources = await client.request(
  { method: "resources/list" },
  ListResourcesResultSchema
);

// 讀取特定資源
const resourceContent = await client.request(
  {
    method: "resources/read",
    params: {
      uri: "file:///example.txt"
    }
  },
  ReadResourceResultSchema
);

創建服務端

import { Server } from "@modelcontextprotocol/sdk/server/index.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";

const server = new Server({
  name: "example-server",
  version: "1.0.0",
}, {
  capabilities: {
    resources: {}
  }
});

server.setRequestHandler(ListResourcesRequestSchema, async () => {
  return {
    resources: [
      {
        uri: "file:///example.txt",
        name: "Example Resource",
      },
    ],
  };
});

server.setRequestHandler(ReadResourceRequestSchema, async (request) => {
  if (request.params.uri === "file:///example.txt") {
    return {
      contents: [
        {
          uri: "file:///example.txt",
          mimeType: "text/plain",
          text: "This is the content of the example resource.",
        },
      ],
    };
  } else {
    throw new Error("Resource not found");
  }
});

const transport = new StdioServerTransport();
await server.connect(transport);

📚 詳細文檔

• Model Context Protocol 官方文檔
• MCP 規範
• 示例服務端

🤝 貢獻

歡迎在 GitHub 提交問題和拉取請求：https://github.com/modelcontextprotocol/typescript-sdk

📄 許可證

此項目以 MIT License 授權，詳細信息見 LICENSE 文件。