Files
registry/README.md

79 lines
2.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# DesireCore Registry
DesireCore 官方应用商店与服务注册表数据仓库。
## 目录结构
```
.
├── README.md # 本文件
├── SCHEMA_VERSION # 数据格式版本2.0.0
├── manifest.json # 仓库元数据
├── apps/
│ └── <app-id>/
│ └── index.json # StoreApp 单个应用配置(含 install 字段)
├── mcp/
│ └── <service-id>/
│ └── index.json # RegisteredService 单个 MCP 服务(含 install + connection
├── services/
│ └── <service-id>/
│ └── index.json # RegisteredService 单个 HTTP 服务
├── models/
│ ├── descriptors.json # ServiceDescriptor[] 模型能力描述符
│ └── categories.json # ServiceCategoryDescriptor[] 模型分类
└── ui-config/
├── app-categories.json # 应用分类配置
└── service-status.json # 服务状态 UI 配置
```
## 数据格式
每个应用/服务为独立目录,目录名即 ID包含 `index.json` 单对象文件:
- `apps/<id>/index.json``StoreApp` schema`install`
- `mcp/<id>/index.json``RegisteredService` schema`install` + `connection`
- `services/<id>/index.json``RegisteredService` schema
- `models/descriptors.json``ServiceDescriptor[]` 数组
- `models/categories.json``ServiceCategoryDescriptor[]` 数组
## 添加新条目
以添加 MCP 服务为例:
```bash
mkdir mcp/my-service
cat > mcp/my-service/index.json << 'EOF'
{
"id": "my-service",
"name": "My Service",
"description": "服务描述",
"protocol": "mcp",
"status": "offline",
"origin": "registry",
...
}
EOF
```
## 同步策略
DesireCore 客户端会:
1. 启动时检查本地缓存2 分钟 TTL
2. 缓存过期时 `git fetch` 检查更新
3. 有更新时 `git pull` 并重建索引
4. 离线时使用本地缓存或内置 fallback 数据
## 贡献指南
1. Fork 本仓库
2. 在对应类型目录下创建以 ID 命名的子目录
3. 添加 `index.json`(单对象,遵循对应 Schema
4. 提交 PR 并描述变更内容
5. 等待审核合并
## 镜像
- GitHub: https://github.com/desirecore/registry.git
- git.hxr.so镜像: https://git.hxr.so/desirecore/registry.git