MCP Server-Client Example

MCP Server-Client Example

site icon
2024.12.27 0
TypeScriptMCP协议实现资源管理其它
该项目是一个基于TypeScript SDK的Model Context Protocol (MCP)基础实现示例,包含通过stdio传输进行通信的服务器和客户端实现。服务器提供资源访问功能,客户端连接服务器并请求资源。主要功能包括资源列表获取、资源内容读取以及基本的错误处理。
View on GitHub

Overview

基本能力

产品定位

该项目是一个MCP(Model Context Protocol)的基础实现示例,主要用于演示如何通过TypeScript SDK构建MCP服务器和客户端。

核心功能

  • 资源列表获取:客户端可以请求服务器上可用的资源列表。
  • 资源内容读取:客户端可以读取服务器上特定资源的内容。
  • 基本错误处理:服务器能够处理未知资源的请求。

适用场景

  • 开发学习:适合开发者学习MCP协议的基础实现。
  • 原型验证:可用于验证MCP协议在特定场景下的可行性。
  • 资源管理:适用于需要集中管理资源的场景。

工具列表

  • MCP服务器:提供资源访问功能,支持资源列表和内容读取。
  • MCP客户端:连接服务器并请求资源。

常见问题解答

  • 如何添加新资源?:修改src/index.ts中的ListResourcesRequestSchema处理器,添加新资源到resources数组。

使用教程

使用依赖

  • Node.js(v16或更高版本)
  • npm

安装教程

  1. 克隆仓库并安装依赖:
npm install

调试方式

  1. 启动服务器:
npm run start:server
  1. 在另一个终端启动客户端:
npm run start:client

客户端将执行以下操作: 1. 连接服务器 2. 请求可用资源列表 3. 读取示例资源的内容

许可证

该项目遵循 ISC 开源许可条款。