README
🚀 @hellocoop/admin-mcp (BETA)
@hellocoop/admin-mcp (BETA) 是一个用于创建和管理 Hellō 应用程序的模型上下文协议(MCP)服务器。借助它,你可以通过AI助手直接创建和管理Hellō应用,操作时还会自动包含完整的开发者上下文信息。
⚠️ 重要提示
此MCP服务器目前处于测试阶段。我们正在积极收集反馈,并欢迎大家贡献代码!如果你发现问题、有改进建议或想提交拉取请求,请不吝行动,帮助我们提升开发者体验。
🚀 快速开始
📦 安装指南
快速配置
将以下配置之一复制到你的MCP客户端设置中:
NPM包(最新版本):
{
"hello-admin-stdio": {
"command": "npx",
"args": ["-y", "@hellocoop/admin-mcp@latest"],
"type": "stdio"
}
}
HTTP传输(远程):
{
"hello-admin-http": {
"url": "https://admin-mcp.hello.coop/",
"type": "http"
}
}
📖 查看本地开发设置 以了解如何从源代码运行。
💻 使用示例
这个MCP服务器提供了一个强大的工具 (hello_manage_app),让你可以直接通过AI助手创建和管理Hellō应用程序。与传统API不同的是,每次操作都会自动包含完整的开发者上下文 —— 个人资料、团队和应用程序,非常适合AI助手使用。
📖 有关详细的使用说明、示例和故障排除方法,请访问:hello.dev/docs/admin-mcp
✨ 主要特性
- 🏢 上下文感知操作:每次工具调用都会自动包含当前的开发者个人资料、团队和应用程序,实现无缝上下文操作。
- 📱 统一的应用程序管理:一个强大的工具即可完成所有应用程序操作(创建、读取、更新、管理密钥、管理徽标)。
- 🔐 安全的OAuth集成:基于浏览器的身份验证,具备JWT令牌验证功能。
- 🌐 多传输支持:支持stdio(本地)和HTTP(远程)MCP传输方式。
- 📊 内置分析功能:进行使用情况跟踪和性能监控,以便进行优化。
- 🎨 徽标管理:支持上传徽标,并自动支持亮/暗主题。
- ⚙️ 环境灵活性:可配置域名和管理服务器。
🛠️ 可用工具
🎯 核心工具
hello_manage_app- 用于所有应用程序管理的主要工具- 操作:
create、read、update、create_secret、update_logo_from_data、update_logo_from_url - 始终包含:每次响应都会包含当前的个人资料、团队和应用程序。
- 自动上下文:如果未指定团队,将自动使用默认团队。
- 智能默认值:如果未提供应用程序名称,将根据个人资料生成。
- 操作:
🌟 主要优势
🔄 始终保持上下文:与传统API不同,每个工具响应都会包含完整的开发者上下文:
- 用户个人资料(姓名、电子邮件、头像)
- 所有团队/组织及其角色
- 所有应用程序及其所属团队
- 当前团队和应用程序状态
这意味着在操作过程中不会丢失上下文,非常适合需要了解完整开发环境的AI助手。
📚 详细文档
hello_manage_app 操作说明
- 📝
create- 创建新应用程序- 如果团队不存在,将自动生成。
- 根据个人资料生成智能默认名称。
- 返回:
{ profile, application, action_result }
- 👁️
read- 读取应用程序详细信息- 不提供
client_id时:返回完整的个人资料上下文。 - 提供
client_id时:返回个人资料 + 特定应用程序。 - 返回:
{ profile, application?, action_result }
- 不提供
- ✏️
update- 更新应用程序设置- 可修改任何应用程序属性。
- 返回:
{ profile, application, action_result }
- 🔑
create_secret- 生成客户端密钥- 创建安全的OAuth客户端密钥。
- 返回:
{ profile, application, client_secret, action_result }
- 🎨
update_logo_from_data- 从base64数据上传徽标- 支持亮/暗主题。
- 自动使用徽标URL更新应用程序。
- 返回:
{ profile, application, update_result, action_result }
- 🔗
update_logo_from_url- 从URL上传徽标- 从提供的URL获取并上传徽标。
- 支持亮/暗主题。
- 返回:
{ profile, application, update_result, action_result }
每个响应都会包含完整的个人资料上下文,非常适合需要了解开发环境的AI助手。
📚 可用资源
- Hellō文档 - 完整的集成文档
- Hellō快速入门指南 - 特定框架的设置指南
- Hellō按钮 - 登录按钮实现指南
- Hellō作用域 - 可用作用域和声明参考
- Hellō钱包API - 钱包API参考文档
- Hellō徽标设计指南 - 创建适合主题的徽标的综合指南
🔧 技术细节
环境变量
HELLO_DOMAIN:覆盖默认域名(默认为hello.coop)HELLO_ADMIN:覆盖管理服务器URL(默认为https://admin.hello.coop)
🤝 贡献与开发
如何贡献
- 🐛 报告问题:GitHub问题 - 如果你发现了漏洞或有功能请求,请在此报告。
- 🔧 提交拉取请求:GitHub拉取请求 - 帮助我们改进服务器。
- 💬 参与讨论:Discord - 分享反馈并获取帮助。
本地开发
要进行本地开发和测试,请执行以下操作:
# 克隆仓库
git clone https://github.com/hellocoop/admin-mcp
cd admin-mcp
# 安装依赖
npm install
然后配置AI客户端以运行本地版本。
本地开发(Node.js):
{
"hello-admin-local": {
"command": "node",
"args": ["path/to/HelloCoop/admin-mcp/src/stdio.js"],
"type": "stdio"
}
}
测试
运行全面的测试套件:
# 运行所有自动化测试
npm test
Scan to join WeChat group