Toolkit MCP Server 使用说明

项目简介

Toolkit MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在为大型语言模型(LLM)客户端提供丰富的系统工具和实用程序。通过标准化的 MCP 协议,LLM Agent 可以安全、可扩展地访问和利用服务器提供的各种能力,扩展 LLM 的功能边界。

主要功能点

  • 网络与地理定位工具

    • IP 地理定位(支持缓存加速)
    • 网络连通性测试
    • Ping 和 Traceroute 网络诊断
    • 公网 IP 地址检测
    • 速率限制,保障服务稳定
  • 系统实用工具

    • 系统信息检索(操作系统、架构、CPU、内存等)
    • 系统资源监控(CPU 负载、内存使用率等)
    • 网络接口详细信息查询
  • 安全工具

    • 密码学哈希生成 (MD5, SHA-1, SHA-256, SHA-512)
    • 恒定时间哈希比较,增强安全性
    • UUID (通用唯一识别码) 生成
  • 生成器工具

    • 二维码生成
      • 终端文本输出
      • SVG 矢量格式
      • Base64 编码图片格式

安装步骤

  1. 使用 npm 安装 (推荐)
    npm install @cyanheads/toolkit-mcp-server
  2. 从源代码安装
    git clone [email protected]:cyanheads/toolkit-mcp-server.git
    cd toolkit-mcp-server
    npm install
    npm run build

服务器配置

要将 Toolkit MCP Server 集成到 MCP 客户端,您需要在客户端的 MCP 服务器设置中添加以下配置。这通常是一个 JSON 格式的配置文件,用于告知客户端如何启动和连接到 MCP 服务器。

{
  "mcpServers": {
    "toolkit": {  // 服务器名称,可以自定义,例如 "toolkit"
      "command": "node", // 启动服务器的命令,这里使用 Node.js 运行时
      "args": ["node_modules/@cyanheads/toolkit-mcp-server/build/index.js"], // 启动命令的参数,指向服务器入口文件
      "env": {
        "NODE_ENV": "production" // 设置环境变量,通常设置为 production
      }
    }
  }
}

配置说明:

  • '"toolkit"': MCP 服务器的名称,您可以自定义,客户端通过此名称引用该服务器。
  • '"command": "node"': 指定用于启动服务器进程的命令。这里 'node' 表示使用 Node.js 运行时环境来执行 JavaScript 代码。
  • '"args": ["node_modules/@cyanheads/toolkit-mcp-server/build/index.js"]': 提供给 'command' 的参数,用于指定服务器的入口文件。'node_modules/@cyanheads/toolkit-mcp-server/build/index.js' 是 Toolkit MCP Server 构建后的主程序文件路径。
  • '"env": { "NODE_ENV": "production" }': 设置服务器运行时的环境变量。'NODE_ENV=production' 通常用于优化 Node.js 应用在生产环境下的性能。

基本使用方法

Toolkit MCP Server 提供了多种工具,可以通过 MCP 客户端调用。以下是一些基本的使用示例,展示了如何通过 'mcp.use' 方法调用服务器提供的工具。

示例代码 (在 MCP 客户端中使用):

// 假设 mcp 是您的 MCP 客户端实例

// 获取地理位置信息
const geo = await mcp.use('toolkit', 'geolocate', { // 'toolkit' 是服务器名称,'geolocate' 是工具名称
  query: '8.8.8.8' // 工具的参数,查询的 IP 地址
});
console.log(geo);

// 检查网络连通性
const connectivity = await mcp.use('toolkit', 'checkConnectivity', {
  host: 'example.com',
  port: 443
});
console.log(connectivity);

// 生成 SHA256 哈希
const hash = await mcp.use('toolkit', 'hashData', {
  input: '需要哈希的数据',
  algorithm: 'sha256'
});
console.log(hash);

// 生成二维码 (SVG 格式)
const qrCode = await mcp.use('toolkit', 'generateQRCode', {
  data: 'https://example.com',
  type: 'svg'
});
console.log(qrCode);

// 获取系统信息
const systemInfo = await mcp.use('toolkit', 'getSystemInfo', {});
console.log(systemInfo);

使用说明:

  1. 确保您的 MCP 客户端已正确配置并连接到 Toolkit MCP Server。
  2. 使用 'mcp.use(serverName, toolName, arguments)' 方法调用工具。
    • 'serverName': 在 MCP 客户端配置中设置的服务器名称 (例如,上面的例子中使用的是 '"toolkit"').
    • 'toolName': 要调用的工具的名称 (例如, '"geolocate"', '"checkConnectivity"', '"hashData"', '"generateQRCode"', '"getSystemInfo"' 等).
    • 'arguments': 传递给工具的参数,参数格式和要求请参考每个工具的 'inputSchema' 定义。
  3. 'mcp.use' 方法返回一个 Promise,resolve 的结果包含了工具执行的输出内容。

请参考仓库的 'README.md' 文件和代码注释,了解更多关于可用工具、参数和使用细节。

信息

分类

开发者工具