使用说明
瓦格·麦克普
Languages / 语言 / 言語 / 언어 / Ngôn ngữ:
通过模型上下文协议的项目元数据管理工具
系统地管理每个项目的变量名、常量和标准术语,并与Cursor IDE集成,以帮助LLM使用一致的命名约定。
🎯 概述
VARGG MCP是一种模型上下文协议实现,可实现开发环境与集中式项目元数据管理系统之间的无缝集成。它有助于团队在项目之间保持一致的命名约定,特别是在使用Cursor IDE等AI助手时。
它解决的问题
- 命名不一致:不同的开发人员对相同的概念使用不同的变量名
- 语言障碍:使用多种语言的团队在术语一致性方面存在困难
- AI上下文丢失:LLM在不了解团队既定惯例的情况下生成代码
- 知识孤岛:项目特定的命名模式不共享或不可发现
- 船上摩擦:新团队成员不知道要遵循什么命名约定
主要功能概述
- 项目型组织:管理每个项目的变量和常量
- 多语言支持:支持韩语、英语、日语、中文和越南语
- 游标IDE集成:通过MCP协议与Cursor IDE直接集成
- 实时搜索:立即搜索现有变量和定义
- 标准术语:在各个项目中保持一致的定义
- 团队协作:在团队中分享和发现命名模式
目标用户
- 开发团队:希望保持一致命名约定的团队
- 多语言项目:涉及多种语言和地区的项目
- 人工智能辅助开发:使用Cursor IDE或类似AI编码助手的开发人员
- 项目经理:跨项目管理标准化术语的团队
✨ 主要特点
🗂️ 基于项目的变量管理
按项目组织变量和常量,使维护特定于项目的命名约定变得容易,同时跨团队共享常见模式。
🌐 多语言支持
完全支持5种语言:
- 🇰🇷 韩语(ko)
- 🇺🇸 英语(en)
- 🇯🇵 日语(ja)
- 🇨🇳 中文(zh)
- 🇻🇳 越南语(vi)
每种语言都有自己的验证规则和变量名和定义的字符集。
🔌 游标IDE集成
通过模型上下文协议与Cursor IDE无缝集成。LLM在生成代码时可以自动搜索并使用团队的标准术语。
🔍 自动标准术语搜索和建议
当LLM生成代码时,它们可以搜索项目的变量库,并建议现有的标准术语,而不是创建新的术语。
⚡ 实时变量搜索和注册
立即搜索现有变量,并在工作时注册新变量。所有操作都是通过MCP协议实时执行的。
🚀 快速开始
先决条件
- 已安装游标IDE
- VARGG帐户(在 是.gg)
- API密钥来自VARGG网站
1.获取API密钥
- 访问 是.gg 并登录
- 导航到您的帐户设置
- 生成用于MCP访问的API密钥
2.配置游标IDE
将VARGG MCP添加到光标IDE设置中:
文件(F)>首选项>光标设置
添加以下配置:
{
"mcpServers": {
"vargg": {
"url": "https://var.gg/mcp/ko/project",
"headers": {
"X-API-KEY": "your-api-key-here"
}
}
}
}
备注:替换 ko 使用您首选的区域设置(en, ja, zh, vi).
替换 your-api-key-here 使用步骤1中的实际API密钥。
3.创建你的第一个项目
在Cursor IDE中,询问AI助手:
Create a new project named "E-Commerce Payment" with description "Payment processing module for e-commerce platform"
或者使用以下web界面 var.gg项目.
4.开始使用变量
让Cursor搜索或创建变量:
Search for variables related to "user account" in the project
Create a variable TOTAL_COUNT with definition "total count" for abbreviation in the project
🛠️ 可用工具
VARGG MCP提供以下工具来管理项目和变量:
项目管理
projects-列出您可以访问的所有项目create_project-创建新项目update_project-更新项目信息open_project_admin-打开项目管理页面以获取权限和用户邀请
变量管理
search_variables-在项目中搜索变量create_variables-在项目中创建新变量list_variables-列出项目中的所有变量(分页)remove_variables-从项目中删除变量
有关每个工具的详细文档,请参阅 工具参考.
📖 文档
- 入门指南 -详细的设置指南
- 工具参考 -所有工具的完整API文档
- 光标集成指南 -逐步设置Cursor IDE
- 最佳实践 -推荐的工作流程和模式
- 用例 -真实世界的例子和场景
- 官方网站 -交互式演示和详细指南
💡 用例
统一团队内的命名约定
确保所有团队成员对常见概念使用相同的变量名。例如,始终使用 USER_ACCOUNT 而不是混合 UserAccount, userAccount, user_account等等。
管理每个项目的标准术语
每个项目都可以有自己的一套标准条款。“支付”项目可能具有 PAYMENT_AMOUNT,而“航运”项目可能 SHIPPING_COST.
确保LLM代码生成的一致性
当您要求Cursor生成代码时,它会搜索项目的变量库并使用现有的标准术语,从而保持所有生成代码的一致性。
在多语言项目中管理变量名
支持多种语言意味着您可以用母语定义变量,同时为代码保留英文变量名。例如, TOTAL_COUNT with a Korean定义“总数”。
🤝 社区
如何贡献
🌐 多语言支持
VARGG MCP支持以下具有本机验证和字符集的语言:
| 语言 | 代码 | 字符集 |
|---|---|---|
| 🇰🇷 朝鲜语 | ko |
韩文+英文+数字+空格+括号 |
| 🇺🇸 英语 | en |
英文字母+数字+空格 |
| 🇯🇵 日语 | ja 平假名+片假名+汉字+영문+숫자 |
|
| 🇨🇳 中文 | zh |
汉字+英文+数字 |
| 🇻🇳 越南语 | vi |
Vietnamese+英文+数字 |
每种语言都有特定的变量名和定义验证规则。看 工具参考 了解详情。
🔗 链接
- 网站: https://var.gg
- MCP指南: https://var.gg/en/mcp (也有ko、ja、zh、vi版本)
- 互动演示: https://var.gg/[区域设置]/mcp -尝试浏览器中的工具
- 问题报告: https://github.com/var-gg/mcp/issues
- 讨论: https://github.com/var-gg/mcp/discussions
📝 许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
⚠️ 重要说明
代码发布
目前,此存储库仅包含文档和社区资源。MCP服务器实现代码尚未开源,但我们可能会在将来发布。请稍后查看更新!
架构说明
VARGG MCP实现使用JSON-RPC 2.0协议接口。CursorIDE使用JSON-RPC 2.0与MCP服务器通信,然后将请求转换为对后端的REST API调用。前端充当Cursor的MCP协议和后端REST API之间的代理层。
版本管理
即使代码没有发布,我们也会跟踪MCP工具的版本和功能变化 更改日志.md.
隐私
在报告问题或讨论功能时,请避免共享个人信息或API密钥。如果您需要共享敏感信息,请私下联系我们。
由以下材料制成❤️ VARGG团队