loco-mcp(Loco Translation MCP 服务器)

使用说明(Markdown 格式)

  • 项目简介

    • loco-mcp 是一个基于 Model Context Protocol (MCP) 的后端服务器。它通过 MCP 的工具机制暴露对 Localise.biz (Loco) API 的访问能力,支持资产管理、翻译管理、标签管理等功能,供 LLM 客户端以统一的 MCP 请求/响应格式进行交互。
  • 主要功能点

    • 注册并暴露一组工具,覆盖以下类别:
      • 本地化语言相关:list_locales
      • 资产管理:list_assets、get_asset、create_asset、update_asset、delete_asset
      • 翻译管理:get_translations、get_translation、update_translation
      • 标签管理:list_tags、tag_asset、untag_asset
    • 通过 Loco API 实现对资产、翻译和标签的实际操作
    • 使用 MCP 标准的 JSON-RPC 风格请求/响应,且通过 Stdio 传输进行通信(适用于命令行/管道场景)
    • 请求输入通过 zod 定义的输入模式进行校验,确保传入的参数符合接口要求
    • 服务端负责会话与能力声明,供客户端探测和调用
  • 安装步骤

    • 需要运行 Node.js 环境(推荐较新版本的 Node.js)
    • 获取源码并安装依赖:安装过程通常包括 npm install 或等效的包管理器安装步骤
    • 构建与运行:代码基于 TypeScript 编写,部署时需要将代码编译成可执行的 JavaScript,然后以 MCP 服务器的入口启动
    • 运行方式示例:可以通过 npm script 或直接运行编译后的入口文件来启动服务器(具体方式以项目提供的构建/发布方式为准)
  • 服务器配置

    • MCP 客户端要连接此服务器,至少需要提供服务器的启动命令和参数,以便在客户端进程中启动并通过标准输入输出与之通信。本服务器使用标准输入输出(stdio)传输,因此客户端需要按照以下配置启动服务器:
    • 配置示例(JSON,直接用于 MCP 客户端配置,用于客户端启动服务器进程): { "server": "loco-mcp", "command": "npx", "args": ["-y", "loco-mcp"] }
    • 注释说明:
      • server: 服务器名称,与代码中使用的 name 相匹配
      • command: 启动服务器所使用的命令(示例使用 npx 跑 loco-mcp 包的入口)
      • args: 启动命令的参数,示例中包含自动确认选项和包名
    • 说明:该配置用于 MCP 客户端通过子进程启动服务器并通过 stdio 与其通信。实际部署中,可能会将 loco-mcp 编排成一个独立进程并通过相同的通信通道对接。
  • 基本使用方法

    • 启动服务器后,MCP 客户端可以通过标准化的 JSON-RPC 请求调用已注册的工具(如 list_assets、get_asset、update_translation 等)
    • 客户端传入参数需符合工具的输入模式(如 apiKey、assetId、locale 等),服务器会返回相应的 JSON-RPC 响应或文本内容
    • 工具返回内容通常包含一个 content 字段,里面是可呈现给 LLM 的文本信息(如 JSON 字符串化后的结果)
    • 使用时请提供 Loco API Key 等必需的认证信息,确保 Loco API 的访问权限有效
  • 备注

    • 该实现是一个完整的 MCP 服务器实例,包含服务器初始化、工具注册、输入校验、与外部 Loco API 的交互等完整流程,且具备可运行的服务器代码框架(通过 Stdio 传输进行通信)。若在实际使用中遇到依赖或构建问题,请参考仓库中的 README 与相应构建脚本进行调整。

服务器信息