模型上下文协议客户端库

mcsm-mcp是一个轻量级的MCP(模型上下文协议)客户端库,支持通过STDIO、SSE和可流式HTTP与MCP兼容服务器通信,适用于CLI脚本和UI工具。

  • by SMGoro
  • TypeScript
  • 本地部署
  • 5 星标
  • 更新于
在 GitHub 查看 SMGoro/mcsm-mcp

使用说明

mcsm-mcp

英语| 中文

概述

mcsm-mcp 是一种轻量级 MCP(模型上下文协议)客户端库 使您的应用程序能够与MCP兼容的服务器通信。它支持多种传输机制—— 工作室, 上海证券交易所,以及 可流式传输的HTTP –并且可以从两者中使用 命令行界面 脚本和 用户界面 工具。


安装

git clone https://github.com/SMGoro/mcsm-mcp.git
cd mcsm-mcp
npm install
npm run build

该软件包适用于Windows、macOS和Linux。


配置和使用

客户端从JSON文件(默认名称 mcp.json).以下是三种支持的传输的示例。

STDIO(默认)

{
  "mcpServers": {
    "my-stdio-server": {
      "type": "stdio",
      "command": "node",
      "args": ["build/index.js", "--debug"],
      "env": {
        "MCSM_API_KEY": "your-api-key",
        "MCSM_API_URL": "http://localhost:23333",
        "DEBUG": "true"
      }
    }
  }
}

可流式传输的HTTP

{
  "mcpServers": {
    "my-http-server": {
      "type": "streamable-http",
      "url": "http://localhost:3010/mcp?mcsm-api-key=your-api-key&mcsm-api-url=http://localhost:23333"
    }
  }
}

将文件另存为 mcp.json 在项目根目录中,或使用指定自定义路径 --config 旗帜。


测试客户端

CLI模式(可编写脚本)

该库附带了一个CLI包装器,可以通过以下方式调用 npx @modelcontextprotocol/inspector.

# Basic usage – start a server and open the UI
npx @modelcontextprotocol/inspector node build/index.js

# CLI mode – run a single command without UI
npx @modelcontextprotocol/inspector --cli node build/index.js --method tools/list

# Using a custom config file
npx @modelcontextprotocol/inspector --cli --config ./mcp.json --server my-stdio-server

UI模式(交互式)

不使用命令运行 --cli 启动 MCP检查器UI 上 http://localhost:6274.

npx @modelcontextprotocol/inspector node build/index.js

您还可以直接从现有配置启动UI:

npx @modelcontextprotocol/inspector --config ./mcp.json

该项目包括一个全面的测试套件,用于验证每种传输(STDIO、SSE、Streamable HTTP)。测试基于 MCP检查员 文件 docs/MCPInspector_README.md.

  1. 打开检查器UI(请参见 UI模式 上文)。
  2. 在 服务器文件 面板点击 “服务器文件” 复制要测试的传输的完整配置。
  3. 将JSON保存到临时文件,例如。 mcp-test.json.
  4. 运行CLI测试命令:
    npx @modelcontextprotocol/inspector --cli --config ./mcp-test.json --method tools/list
    
  5. 验证输出是否与服务器的预期工具列表匹配。

GUI和CLI模式都由CI管道自动执行。

项目链接


许可证

AGPL-3.0