关键词

MCP工具包上下文服务器LLM应用框架TypeScript服务端客户端库

使用说明

项目简介

Mokei 是一个全面的 TypeScript 工具包，旨在简化 Model Context Protocol (MCP) 服务器和客户端的开发。它提供了一系列库和工具，用于构建能够管理资源、工具和 Prompt 的 LLM 应用后端服务。

主要功能点

  • MCP 服务器和客户端库: 提供完整的 MCP 协议服务器和客户端库，方便开发者快速构建符合 MCP 标准的应用。
  • Host 组件: 包含 Host 组件，用于管理和协调多个上下文服务器，支持上下文的生命周期管理。
  • Monitor UI: 内置监控用户界面，用于实时观察和调试 Host 事件，方便开发者监控和管理 MCP Host 运行状态。
  • 命令行工具 (CLI): 提供强大的命令行界面，用于与 MCP Host 和服务器进行交互和管理，例如启动监控器、代理上下文服务器等。
  • 多传输协议支持: 支持多种传输协议，如 Stdio, Socket, HTTP，确保 MCP 服务器可以灵活部署在不同环境中。

安装步骤

请确保已安装 Node.js 和 npm。在项目根目录下或需要使用 Mokei 的项目中执行以下命令安装必要的包：

npm install @mokei/host @mokei/context-server @mokei/context-client @mokei/host-monitor @mokei/cli

服务器配置

MCP 服务器是为 MCP 客户端提供服务的后端应用。MCP 客户端需要配置 MCP 服务器的启动命令及其参数，才能与之建立连接。以下是一个使用 Mokei 构建的 MCP 服务器的客户端配置示例 (JSON 格式):

{
  "serverName": "my-mcp-server",
  "command": "node",
  "args": [
    "path/to/your/mcp-server/dist/index.js",  // 替换为您的 MCP 服务器入口文件路径
    "--config",                               // 示例参数，根据您的服务器需求可能不同
    "config.json"                              // 示例参数，指向服务器配置文件
  ]
}

配置信息参数注释:

  • 'serverName': 为您的 MCP 服务器配置指定一个易于识别的名称。
  • 'command': 启动 MCP 服务器的可执行命令，通常是 'node' (如果服务器是 Node.js 应用) 或 'python' (如果服务器是 Python 应用) 等。
  • 'args': 一个字符串数组，包含启动服务器命令所需的参数。
    • 数组中的第一个元素 '"path/to/your/mcp-server/dist/index.js"' 应替换为您的实际 MCP 服务器入口文件路径。
    • 后续的参数 (例如 '--config', 'config.json') 是服务器可能需要的其他配置参数，例如配置文件路径、端口号等。这些参数需要根据您使用的具体 MCP 服务器实现进行调整。

基本使用方法

  1. 启动 MCP 服务器: 根据您选择的 MCP 服务器实现，使用相应的命令启动服务器。例如，如果您使用了 'mcp-servers/sqlite' 示例，则需要先构建该示例，然后使用 'node mcp-servers/sqlite/dist/index.js --db your_database.db' 命令启动。
  2. 配置 MCP 客户端: 在您的 MCP 客户端应用中，根据上述 “服务器配置” 示例，配置连接到您的 MCP 服务器所需的 'command' 和 'args'。
  3. 使用 MCP 客户端库: 使用 '@mokei/context-client' 提供的客户端库，通过配置信息与 MCP 服务器建立连接，并调用服务器提供的资源、工具和 Prompt 功能，构建您的 LLM 应用。

示例

如果您使用 Mokei CLI 工具 'mokei context monitor' 启动监控器，即可通过浏览器访问监控界面，观察和管理您的 MCP Host 以及连接的上下文服务器。 如果您使用 Mokei CLI 工具 'mokei chat ollama'，即可与本地 Ollama 模型进行交互，并通过 MCP Host 管理上下文和工具。

信息

分类

开发者工具

访问项目