McBopomofo Web MCP 服务器

关键词

输入法服务Braille点字转换注音转汉字汉字拼音

Markdown 使用说明

  • 项目简介

    • 该项目实现了一个 MCP 服务器，用 Node.js 编写，注册了多种文本转换工具（如将注音转成点字、将点字转成注音、将汉字转拼音等），并通过 MCP 协议暴露统一的接口供 LLM 客户端调用。
    • 服务器端代码核心在于 src/mcp.ts，使用 @modelcontextprotocol/sdk 提供的 MCP 服务器框架，注册若干转换工具，并以 StdioTransport 进行通信。

  • 主要功能点

    • 资源与工具管理：托管并暴露资源与工具，LLM 客户端可读取或调用工具实现外部功能。
    • 提供多种转换工具：包括
      • convertBrailleToText（点字转国字）
      • convertTextToBraille（国字转点字）
      • convertBpmfToBraille（注音转点字）
      • convertBrailleToBpmf（点字转注音）
      • convertTextToBpmfReadings（文本转注音读音）
      • convertTextToPinyin（文本转汉语拼音）
    • 通过 JSON-RPC 与客户端通信，支持会话管理与能力声明。

  • 安装步骤

    • 在本地环境安装 Node.js。
    • 通过仓库提供的构建命令构建 MCP 服务：
      • npm install
      • npm run build:mcp
    • 构建完成后，产物位于 output/mcp/index.js。

  • 服务器配置（给 MCP 客户端使用的配置信息）

    • MCP 客户端需要知道服务器的启动命令及参数，以便通过 MCP 客户端与之建立连接。以下信息基于仓库中的实现：
      • 服务器名称（server name）: mcp-mcbopomofo
      • 启动命令（command）: node
      • 参数（args）: ["/PATH/TO/output/mcp/index.js"] 其中 PATH 需要替换为实际的本地路径，指向构建输出中的 index.js（output/mcp/index.js）
    • 注意：这是 MCP 客户端使用的连接配置示例，客户端不需要改变或运行服务器端代码。
    • 说明：在 Claude 等环境的示例配置基础上，服务器名称、启动命令以及路径需要与你的部署路径保持一致。此处给出与本仓库实现对应的准确字段。

  • 基本使用方法

    • 构建并启动 MCP 服务器：
      • 在代码库根目录执行构建命令（npm run build:mcp），生成输出在 output/mcp/index.js。
      • 进入输出目录：cd output/mcp
      • 启动服务器：node index.js
    • 配置 MCP 客户端以连接本服务器：
      • 在客户端的配置中添加一个本地 MCP 服务器条目，名称设为 mcp-mcbopomofo，命令设为 node，参数为构建产物的绝对路径，例如 ["/path/to/output/mcp/index.js"]。
    • 使用方法（客户端侧）：
      • 通过 MCP 客户端发送 JSON-RPC 请求，调用上述注册的工具（如 convertTextToPinyin、convertTextToBraille 等），服务器将返回相应的 JSON-RPC 响应。
      • 服务端默认实现了会话管理与能力声明，确保与客户的协作模式一致。

  • 额外信息

    • 该 MCP 服务器与 McBopomofoWeb 的其他组件协同工作，可将文本转换能力暴露给 LLM，支持将结果作为上下文或直接调用的工具输出。

服务器信息

访问项目