Search1api

🚀 MCP TypeScript SDK

TypeScript 实现的模型上下文协议（MCP），提供客户端和服务端的功能，便于集成到大语言模型（LLM）中。通过该 SDK，开发者能以标准化方式为大语言模型提供上下文信息，将上下文提供与实际的语言模型交互分离开来。

🚀 快速开始

创建客户端

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

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

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

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";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio";

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

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",
        }
      ]
    };
  }
});

await server.start(new StdioServerTransport());

✨ 主要特性

• 构建可以连接到任何 MCP 服务器的客户端。
• 创建暴露资源、提示和工具的 MCP 服务器。
• 使用标准传输协议如 stdio 和 SSE。
• 处理所有 MCP 协议消息和生命周期事件。

📦 安装指南

npm install @modelcontextprotocol/sdk

💻 使用示例

基础用法

// 创建客户端示例
import { Client } from "@modelcontextprotocol/sdk/client";
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio";

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

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

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";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio";

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

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",
        }
      ]
    };
  }
});

await server.start(new StdioServerTransport());

📚 详细文档

模型上下文协议允许应用程序以标准化方式为大语言模型提供上下文信息，将上下文提供与实际的语言模型交互分离开来。此 TypeScript SDK 实现了完整的 MCP 规范，使其易于构建客户端和服务器，使用标准传输协议，并处理所有 MCP 协议消息和生命周期事件。