使用说明

项目简介

'modelcontextprotocol_typescript-sdk' 是一个用 TypeScript 编写的 SDK，实现了 Model Context Protocol (MCP) 协议。它旨在帮助开发者构建 MCP 客户端和服务器，以便为大型语言模型 (LLM) 提供标准化的上下文信息和功能。

主要功能点

提供 MCP 客户端和服务端 SDK。
支持资源 (Resources) 管理和访问。
支持工具 (Tools) 注册和调用。
支持 Prompt 模板 (Prompts) 定义和渲染。
支持 Stdio, SSE, WebSocket 等多种传输协议。

安装步骤

npm install @modelcontextprotocol/sdk

服务器配置

MCP 服务器可以通过命令行或 HTTP 接口启动。以下是基于仓库信息生成的可能的配置信息，用于 MCP 客户端连接到 MCP 服务器：

{
  "serverName": "mcp-typescript-server",
  "stdio": {
    "command": "path/to/your/server/executable", //  请替换为您的 MCP 服务器可执行文件的路径
    "args": [] // 启动服务器所需的命令行参数，例如端口号等
  },
  "sse": {
    "url": "http://localhost:3000/sse" //  SSE 服务器的 URL，请根据实际情况修改
  },
  "websocket": {
    "url": "ws://localhost:3000" // WebSocket 服务器的 URL，请根据实际情况修改
  }
}

参数注释:

'serverName': MCP 服务器的名称，用于客户端识别。
'stdio': 使用标准输入输出流 (stdio) 连接服务器的配置。
- 'command': 启动 MCP 服务器的命令行命令，通常是服务器可执行文件的路径。
- 'args': 传递给服务器命令的参数列表。
'sse': 使用 Server-Sent Events (SSE) 连接服务器的配置。
- 'url': SSE 服务器的 URL 地址。
'websocket': 使用 WebSocket 连接服务器的配置。
- 'url': WebSocket 服务器的 URL 地址。

基本使用方法

安装 SDK： 'npm install @modelcontextprotocol/sdk'
创建 MCP 服务器实例并配置资源、工具和 Prompt 模板。
选择合适的传输协议 (Stdio, SSE, WebSocket) 并启动服务器。
在 MCP 客户端中使用 SDK 连接到 MCP 服务器。
使用客户端 SDK 的 API 发送请求，例如 'client.request({ method: "resources/list" }, ListResourcesResultSchema)' 来获取资源列表。

关键词