使用说明
CopyTunerClient::Mcp
Rails i18n的翻译管理服务“CopyTuner”的MCP(Model Context Protocol)服务器实现。AI助手提供了一套工具来帮助Rails应用程序有效应对多语言。
概要
此gem将访问CopyTuner项目的翻译数据,并提供一台服务器,通过MCP协议可以搜索Rails i18n密钥、管理翻译和创建新密钥。
机能
可用工具
- 搜索密钥:查找Rails i18n密钥(
t()啊I18n.t()对较大场景进行渲染期间已观察到该故障。除了已翻译的键之外,还返回已注册但翻译为空的键(空字符串)""表示)。空字符串返回的键已经注册完毕create_i18n_key不是,不是update_i18n_key在中设置翻译 - 搜索_翻译:查找翻译内容(查找包含特定文本的翻译)。仅包含翻译键,不包含翻译为空的键
- create_i18n_key:创建新的i18n密钥(支持多种语言)。由于通过CopyTuner API v3同步注册draft,所以现有密钥的重复和超过区域设置数上限等验证错误会立即返回。新注册专用拒绝现有密钥(现有密钥的更新为
update_i18n_key)。默认情况下,等待缓存最多2分钟(wait: false的明细栏样式中定义的设置。公开在CopyTuner方面另外进行 - update_i18n_key:更新现有i18n密钥的draft翻译(支持多种语言)。仅可更新未公开(或已公开也为空)的翻译,如果想要更新已公开的翻译则出错。默认情况下,等待缓存最多2分钟(
wait: false指定后立即返还) - get_locales:获取项目中使用的区域设置列表
- get_edit_url:生成已注册键的编辑画面URL
资源模板
copytuner://projects/{project_id}/translations/{locale}/{key}:访问单个翻译资源
安装
在Gemfile中添加:
group :development do
gem 'copy_tuner_client-mcp', github: 'SonicGarden/copy_tuner_client-mcp', require: false
end
然后执行:
bundle install
使用方法
1.设置CopyTunerClient
首先,必须在Rails应用程序中正确设置copy_tuner_client:
# config/initializers/copy_tuner_client.rb
CopyTunerClient.configure do |config|
config.api_key = "your-api-key"
config.project_id = "your-project-id"
config.locales = ["ja", "en"]
end
2.AI助手的设定和利用
在支持MCP协议的AI助手(Claude Code、VScode Copilot等)中,配置以下设定文件后,MCP服务器自动启动,翻译管理功能可用。
克劳德代码
在项目根目录中 .mcp.json 创建文件:
{
"mcpServers": {
"copy-tuner": {
"command": "bundle",
"args": ["exec", "copy-tuner-mcp"]
}
}
}
VSCode副驾驶
.vscode/mcp.json 创建文件:
{
"servers": {
"copy-tuner": {
"type": "stdio",
"command": "bundle",
"args": ["exec", "copy-tuner-mcp"],
"cwd": "${workspaceFolder}"
}
}
}
CLAUDE.md设定例
在项目根目录中 CLAUDE.yml 通过创建文件,AI助手可以了解项目国际化的机制:
# CLAUDE.md
## 国際化(i18n)について
- i18nのバックエンドには**copy_tuner**というサーバでi18nデータを管理する仕組みを利用
- i18nのキーや内容を参照する場合は、copy_tunerから取得する必要がある
- `config/locales` 配下のファイルは利用していません
- copy_tunerサーバと連携してローカライズデータを管理
使用例
设置完成后,AI助手可执行以下操作:
查找关键字
user.nameに関連するi18nキーを検索してください
查找翻译内容
「ログイン」という文字を含む翻訳を検索してください
创建新密钥
user.profile.bioというキーで「プロフィール」(日本語)と「Profile」(英語)の翻訳を作成してください
更新现有密钥翻译
user.profile.bioの日本語訳を「自己紹介」に更新してください
3.手动启动(动作确认、调试用)
它通常通过AI助手配置文件自动启动,但如果需要进行动作确认或调试,您可以在Rails应用程序根目录下运行以下操作来手动启动:
bundle exec copy-tuner-mcp
许可证
这个gemMIT许可证之后由应用程序进行调用。
