使用说明

项目简介

本项目 'mcp-helper-tools' 是一个基于 Model Context Protocol (MCP) 构建的工具服务器，旨在为 LLM 客户端提供一系列实用的系统工具和功能。通过 MCP 协议，LLM 应用可以安全、便捷地调用服务器提供的各种能力，扩展自身的功能边界。

主要功能点

• 编码解码工具：支持 Base64、URL、HTML 等多种编码格式的编解码操作。
• 网络与地理位置：提供 IP 地址地理位置查询功能，具备智能缓存和速率限制，保护服务稳定运行。
• 安全工具：集成多种加密哈希算法（MD5, SHA-1, SHA-256, SHA-512）用于数据摘要，支持常量时间哈希比较，并能生成 UUID。
• 生成器工具：支持生成二维码，可输出终端字符画、SVG 矢量图或 Base64 编码的图片格式。

安装步骤

1. 前提条件：确保您的环境中已安装 Node.js 和 npm (Node 包管理器)。
2. 安装命令：在您的项目目录或希望安装的位置，运行以下 npm 命令安装 '@cyanheads/toolkit-mcp-server'：

   npm install @cyanheads/toolkit-mcp-server
   

服务器配置

为了让 MCP 客户端能够连接到 'mcp-helper-tools' 服务器，您需要在 MCP 客户端的配置中添加服务器信息。以下是一个典型的 JSON 格式配置示例，您需要将其添加到您的 MCP 客户端配置文件中：

{
  "mcpServers": {
    "toolkit": {
      "command": "node",
      "args": ["node_modules/@cyanheads/toolkit-mcp-server/build/index.js"]
    }
  }
}

配置参数说明：

• 'mcpServers': 定义可用的 MCP 服务器列表。
• 'toolkit': 为当前服务器定义一个名称，例如 "toolkit"，您可以根据需要自定义此名称。
• 'command': 指定启动 MCP 服务器的命令。由于 'mcp-helper-tools' 是 Node.js 应用，这里设置为 'node'，表示使用 Node.js 运行时环境。
• 'args': 传递给 'command' 的参数，用于指定服务器的入口文件。'node_modules/@cyanheads/toolkit-mcp-server/build/index.js' 指向已安装的 'mcp-helper-tools' 包中编译后的 'index.js' 文件，这是服务器程序的启动入口。

基本使用方法

配置完成后，您的 MCP 客户端就可以通过指定的服务器名称 "toolkit" 调用 'mcp-helper-tools' 提供的工具了。以下是一些基本的使用示例（假设在 MCP 客户端环境中使用）：

// 示例：使用地理定位工具查询 IP 地址信息
const geo = await mcp.use('toolkit', 'geolocate', { query: '8.8.8.8' });
console.log(geo);

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

// 更多工具和详细参数请参考仓库的 README 文档或源代码，根据工具的 inputSchema 传入相应的参数。

请注意，上述代码示例中的 'mcp.use' 方法是 MCP 客户端提供的用于调用 MCP 服务器工具的接口。实际使用时，请参考您的 MCP 客户端的具体文档。