使用说明

项目简介

JS MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器端实现,旨在为大型语言模型 (LLM) 应用提供结构化的上下文管理服务。它允许开发者以标准化的方式管理和提供资源、工具和 Prompt 模板,从而简化 LLM 应用的构建和维护。

主要功能点

  • 资源管理 (Resources): 集中管理和提供 LLM 应用所需的数据资源,支持客户端按需访问。
  • 工具注册与执行 (Tools): 允许注册外部功能模块(工具),并支持 LLM 客户端远程调用这些工具来扩展其能力。
  • Prompt 模板 (Prompts): 提供灵活的 Prompt 模板定义和渲染机制,支持定制化的 LLM 交互模式。
  • JSON-RPC 协议: 使用标准的 JSON-RPC 协议与客户端进行通信,确保互操作性和易用性。
  • 多种传输协议支持: 支持 Stdio, WebSocket, SSE 等多种传输协议,适应不同的应用场景。

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 全局安装 '@positive-spaces/js-mcp-server' 包:
    npm install -g @positive-spaces/js-mcp-server

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 JS MCP Server。请根据您的实际需求进行配置。

{
  "serverName": "js-mcp-server",
  "command": "js-mcp-server",
  "args": []
  // "args": ["--stdio"]  // 如果需要使用 Stdio 传输协议,可以添加此参数
  // "args": ["--websocket", "--port", "8080"] // 如果需要使用 WebSocket 传输协议,可以配置端口
  // "args": ["--sse", "--port", "8081"] // 如果需要使用 SSE 传输协议,可以配置端口
}

配置参数说明:

  • 'serverName': 服务器名称,用于在客户端标识服务器。
  • 'command': 启动 MCP 服务器的命令。全局安装后,可以直接使用 'js-mcp-server' 命令。
  • 'args': 启动命令的参数。
    • 默认情况下,服务器使用 Stdio 传输协议。
    • 可以通过 '--stdio', '--websocket', '--sse' 参数指定传输协议。
    • 使用 '--websocket' 或 '--sse' 时,可以使用 '--port' 参数指定端口号。

基本使用方法

  1. 安装 JS MCP Server 后,在终端中直接运行 'js-mcp-server' 命令即可启动服务器(默认使用 Stdio 传输协议)。
  2. 配置 MCP 客户端,使其能够连接到运行中的 JS MCP Server。具体的客户端配置方法请参考 MCP 客户端的文档。
  3. 客户端通过 JSON-RPC 协议向服务器发送请求,例如读取资源、调用工具或获取 Prompt。
  4. 服务器处理请求并返回 JSON-RPC 响应或发送通知给客户端。

请参考仓库 https://github.com/Positive-Spaces/js-mcp-server 获取更详细的文档和示例。

信息

分类

AI与计算