Phrase MCP Server

使用说明(Markdown格式)

  • 项目简介

    • 该仓库实现了一个可运行的 MCP 服务器,用于通过 JSON-RPC 向 LLM 客户端提供 Phrase 的资源信息、工具执行能力以及提示模板渲染能力。核心支持 Strings 与 TMS 两类产品的资源管理与工具调用,便于在 AI 工作流中进行本地化自动化。
  • 主要功能点

    • 资源托管与访问:通过产品客户端暴露企业资源(如项目、语言、上传、 glossaries 等)的读取能力。
    • 工具注册与执行:为 Strings 与 TMS 提供大量工具,例如创建/获取项目、列表、下载、创建作业、模板等,工具注册到 MCP 服务端后可被客户端调用。
    • 提示模板与渲染:通过统一的 MCP 服务暴露工具的输出,便于 LLM 在对话中渲染和使用。
    • JSON-RPC 通信:服务器通过标准的 JSON-RPC 方式与客户端通信,返回资源、工具执行结果或错误信息。
    • 多传输协议:当前实现以标准输入输出(Stdio)为传输,后续可扩展为 SSE、WebSocket 等传输。
    • 会话与区块授权:通过 Token 认证与区域/产品选择实现对接 Phrase 平台 API 的授权访问。
  • 安装步骤

    • 需要环境
      • Node.js 20 及以上
    • 快速搭建步骤
      • 安装并运行:直接按仓库提供的快速启动方式在支持的环境中执行即可(例如通过 npx phrase-mcp-server 启动)。
      • 配置所需的 Phrase API 令牌(Strings_TOKEN、TMS_TOKEN)以及区域和启用的产品组合。
    • 运行与测试
      • 服务器启动后,能够通过 MCP 客户端连接,进行资源读取、工具调用和提示渲染。
  • 服务器配置(示例配置为 JSON,注释说明请参阅下方注释) 请以客户端配置的方式提供服务器信息,示例(请用实际值替换引号中的内容): { "server_name": "phrase", "command": "npx", "args": ["-y", "phrase-mcp-server"], "PHRASE_STRINGS_TOKEN": "your_strings_token", "PHRASE_TMS_TOKEN": "your_tms_token", "PHRASE_ENABLED_PRODUCTS": "strings,tms", "PHRASE_REGION": "eu" } 注释说明:

    • server_name: MCP 服务器在客户端配置中引用的名称,建议与项目名称保持一致,如 phrase。
    • command / args: 运行服务器的命令及参数,本文档中推荐使用 npx phrase-mcp-server 启动。
    • PHRASE_STRINGS_TOKEN: Strings 产品所需的 API 令牌。Strings 功能启用所必需,若仅使用 TMS 可不设置或留空。
    • PHRASE_TMS_TOKEN: TMS 产品所需的 API 令牌。TMS 功能启用所必需,若仅使用 Strings 可不设置或留空。
    • PHRASE_ENABLED_PRODUCTS: 启用的产品集合,逗号分隔,可选值 strings,tms,默认为全部。
    • PHRASE_REGION: Phrase 区域,eu 或 us,默认 eu。
  • 基本使用方法

    • 第一步:在 MCP 客户端配置中指定服务器信息(server_name、command、args、环境变量等)。
    • 第二步:设置 Phrase 的 API 令牌及区域信息(环境变量 PHRASE_STRINGS_TOKEN、PHRASE_TMS_TOKEN、PHRASE_REGION),以及启用的产品集合 PHRASE_ENABLED_PRODUCTS。
    • 第三步:启动服务器并使用 MCP 客户端连接,发送 JSON-RPC 请求以读取资源、执行工具、获取 Prompts。
    • 第四步:根据需要扩展配置,例如切换传输协议(Stdio/WS 等)或调整并发策略。

服务器信息