Toonify MCP 服务器 使用说明

• 项目简介

  • 该仓库实现了一个基于 MCP（Model Context Protocol）的后端服务器，用于对结构化数据（JSON、CSV、YAML 等）进行 TOON 格式优化，从而降低对 Claude API 的令牌消耗。服务器提供对外工具调用接口，能够对“优化内容”进行处理并返回结果，同时内置本地指标统计。
  • 核心组件包括一个 MCP 服务器实现、一个令牌优化器（TokenOptimizer）以及一个本地指标收集器（MetricsCollector）。服务器通过标准输入输出（stdio）与 MCP 客户端通信。

• 主要功能点

  • MCP 服务器核心：实现 ListTools 与 CallTool 请求处理，按照 MCP 协议接收请求、返回响应、并支持通用工具调用与统计查询。
  • TOON 优化引擎整合：对 JSON、CSV、YAML 等结构化数据进行 TOON 编码，并计算令牌节省百分比，若达到阈值则返回优化结果。
  • 自动化与可观测性：内置本地化的统计收集与格式化仪表盘输出能力，帮助评估优化效果。
  • 插件/服务器双模式：作为插件可自动拦截工具结果进行优化，亦可作为独立 MCP 服务器供其他 MCP 客户端使用。
  • 配置与安全性：提供基于配置文件/环境变量的优化阈值、跳过工具模式等设置，确保灵活性与可控性。

• 安装步骤

  • 安装全局工具（NPM）后即可使用：
    • 作为插件自动模式：安装工具并添加 Claude Code 插件。
    • 作为 MCP 服务器（手动模式）：全局安装后通过 MCP 客户端注册服务器并直接调用工具。

• MCP 服务器配置（示例，供 MCP 客户端使用的连接信息）

  • 服务器名称：toonify
  • 启动命令：toonify-mcp
  • 启动参数（如有）：请根据实际部署情况填写，通常为空数组
  • 说明：MCP 客户端需要的配置信息用于建立连接，具体如下所示（请以文本形式提供给客户端，不需要直接粘贴代码块）： { "serverName": "toonify", "command": "toonify-mcp", "args": [] }
  • 注：以上配置用于 MCP 客户端在启动阶段注册并连接到 Toonify MCP 服务器。实际参数可能会因运行环境而异，请按部署需求调整。

• 基本使用方法

  • 以插件模式运行（自动优化）：在 Claude 环境中安装 toonify-mcp 插件，插件会在读取、Grep 等工具结果返回前后自动进行 TOON 化优化并传递给 Claude。
  • 以 MCP 服务器模式使用（手动优化）：通过 Claude 的 MCP 命令注册 toonify 服务器后，显式调用 optimize_content 工具对内容进行优化，再获取优化结果与统计信息。
  • 监控与统计：通过 get_stats 工具获取当前统计数据，理解优化的覆盖率与 token 节省效果。