使用说明

项目简介

ToolBox Server 是一个基于 Model Context Protocol (MCP) 构建的强大自动化工具平台。它作为一个 MCP 服务器，旨在为大型语言模型 (LLM) 客户端提供丰富的工具、动态资源和可定制的 Prompt 模板，从而扩展 LLM 的能力边界，使其能够安全、可扩展地访问外部数据和功能。

主要功能点

模块化工具 (Tools)：提供丰富的工具集，涵盖文件系统操作、数据库交互（MongoDB, Redis, SQLite）、SSH 远程执行、Excel/CSV 处理、压缩解压、计算器、定时任务等，工具可通过 'src/tools' 目录热重载，易于扩展和定制。
动态资源 (Resources)：资源由工具执行动态生成，例如 'create_note' 工具创建的笔记资源，可通过 URI 标准化访问。
Prompt 模板 (Prompts)：支持定义和渲染 Prompt 模板，内置 'summarize_notes' 提示词，方便用户定制与 LLM 的交互模式。
工作流工具 (Workflow Tool)：内置 'workflow_tool'，支持串行和并行编排多个工具，实现复杂自动化流程，具备事务管理、详细报告和自定义输出等企业级特性。
企业级能力：集成生产环境常用服务，如 MongoDB、Redis、SSH，支持混合云部署，满足企业级应用需求。
开发者友好：采用 TypeScript 开发，代码结构清晰，提供实时调试、热重载机制，方便开发者进行二次开发和工具扩展。
实时更新：通过 'buildReload_tool' 工具实现零停机热更新，保证服务持续可用性。

安装步骤

安装 Node.js 和 npm: 确保你的环境中已安装 Node.js 和 npm (Node 包管理器)。

下载仓库代码: 将 ToolBox 仓库代码克隆到本地。

git clone https://github.com/xiaoguomeiyitian/ToolBox.git
cd ToolBox

安装依赖: 在项目根目录下运行 npm 命令安装项目依赖。
```
npm install
```
构建服务器: 运行 npm 命令构建服务器代码。
```
npm run build
```
开发模式 (可选): 如果需要进行开发，可以使用以下命令启动自动重构建模式。
```
npm run watch
```

服务器配置

MCP 服务器需要配置到 MCP 客户端才能使用，以下是 Claude Desktop 客户端的 MCP 服务器配置示例，请将以下 JSON 配置添加到 Claude Desktop 的配置文件中：

macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

{
  "serverName": "ToolBox", // MCP 服务器名称，可自定义
  "command": "node", // 启动服务器的命令，这里使用 node
  "args": [
    "--inspect=9229", // 开启 Node.js 检查器，用于调试 (可选)
    "/MCP/ToolBox/build/index.js" // ToolBox 服务器入口文件路径，请替换为实际路径
  ],
  "env": {
    "MONGO_URI": "mongodb://user:password@host:port/db", // MongoDB 连接 URI，根据实际 MongoDB 服务配置
    "MONGO_INDEX_OPS": "true", // 是否允许执行索引操作，默认为 false，如需索引操作请设置为 true
    "REDIS_URI": "redis://:password@host:port", // Redis 连接 URI，根据实际 Redis 服务配置
    "SSH_server1_URI": "username:password@host:port" // SSH 服务器 1 连接 URI，格式为 username:password@host:port，可配置多个 SSH 服务器，命名server1、server2...
  },
  "disabled": false, // 是否禁用该服务器，false 为启用，true 为禁用
  "autoApprove": [] // 自动批准的工具列表，配置后客户端调用列表中的工具无需用户手动批准
}

注意:

请将 '"/MCP/ToolBox/build/index.js"' 替换为 ToolBox 服务器入口文件 'build/index.js' 在你本地文件系统中的绝对路径。
'env' 字段用于配置环境变量，例如数据库连接信息、API 密钥等。请根据你使用的工具配置相应的环境变量。
'MONGO_INDEX_OPS' 环境变量用于控制是否允许执行 MongoDB 索引操作，索引操作具有一定的风险，请谨慎开启。
'SSH_server1_URI' 等环境变量用于配置 SSH 服务器连接信息，请务必妥善保管包含密码等敏感信息的环境变量。
'autoApprove' 字段用于配置自动批准的工具列表，请谨慎配置自动批准工具，避免潜在的安全风险。

基本使用方法

启动 MCP 服务器: 配置完成后，启动 Claude Desktop 客户端，ToolBox Server 将自动启动并与客户端建立连接。
客户端使用工具、资源和 Prompt: 在 Claude Desktop 客户端中，你可以像使用普通功能一样调用 ToolBox Server 提供的工具、访问资源和使用 Prompt 模板。例如，你可以：
- 使用 'create_note' 工具创建笔记。
- 使用 'redis_tool' 工具操作 Redis 数据库。
- 使用 'time_tool' 工具获取当前时间。
- 使用 'summarize_notes' Prompt 总结笔记。
- 使用 'workflow_tool' 工具编排复杂的工作流程。

具体工具、资源和 Prompt 的使用方法，请参考仓库中的 TOOL.md 和 prompt.md 文档。

关键词