内容
# 计算节点应用
Cyoda 平台内计算节点的综合应用框架。本项目为开发以实体为驱动的应用程序提供结构化基础，包括工作流自动化，构建于异步 Quart 网络框架之上。
## 这是什么？
这是一个 **Cyoda 计算节点** - 一种特殊应用程序：
- 在 Cyoda 生态系统中管理 **实体**（结构化数据模型）
- 执行 **工作流**（有限状态机）以处理实体状态转换
- 通过 gRPC 与 Cyoda 平台集成，实现无缝数据同步
- 为实体管理和工作流操作提供 REST API
- 通过模型上下文协议（MCP）支持 AI 助手集成
## 项目结构
```
├── application/ # 您的应用程序代码（实体、工作流、路由）
├── common/ # 共享基础设施（认证、配置、gRPC、存储库）
├── cyoda_mcp/ # 用于 AI 助手集成的 MCP 服务器
├── example_application/ # 参考实现
├── services/ # 服务配置和初始化
└── tests/ # 全面的测试套件
```
### 关键目录
- **`application/`** - 您的自定义业务逻辑
- `entity/` - 实体定义和工作流实现
- `routes/` - REST API 端点
- `processor/` - 自定义处理器和条件函数
- **`cyoda_mcp/`** - 用于 AI 集成的 MCP 服务器
- 参见 [cyoda_mcp/README.md](cyoda_mcp/README.md) 获取 MCP 服务器文档
- **`common/`** - 共享基础设施（除非必要，否则不要修改）
- `auth/` - 认证和令牌管理
- `config/` - 配置和环境变量
- `grpc_client/` - Cyoda gRPC 集成
- `repository/` - 数据访问层
- `service/` - 业务逻辑接口
- **`example_application/`** - 展示最佳实践的参考实现
## 快速入门
### 1. 设置环境
```bash
# 克隆存储库
git clone <存储库网址>
cd mcp-cyoda-quart-app
# 创建虚拟环境
python -m venv .venv
source .venv/bin/activate # 在 Windows 上：.venv\Scripts\activate
# 安装依赖项
pip install -r requirements.txt
```
### 2. 配置凭证
```bash
export CYODA_CLIENT_ID="您的客户端 ID"
export CYODA_CLIENT_SECRET="您的客户端密钥"
export CYODA_HOST="client-<ID>.eu.cyoda.net"
```
### 3. 运行应用程序
```bash
# 运行应用程序服务器
python -m application.app
# 或运行用于 AI 集成的 MCP 服务器
python -m cyoda_mcp
```
## MCP 服务器集成
本项目包含一个 **模型上下文协议（MCP）服务器**，使 AI 助手能够与您的 Cyoda 应用程序交互。
有关完整的 MCP 服务器文档，请参见： **[cyoda_mcp/README.md](cyoda_mcp/README.md)**
### 快速 MCP 设置
```bash
# 全局安装
pipx install mcp-cyoda
# 运行服务器
mcp-cyoda
```
## 开发
### 代码质量
```bash
# 运行所有质量检查
python -m black . && python -m isort . && python -m mypy . && python -m flake8 . && python -m bandit -r .
# 运行测试
python -m pytest tests/ -v
```
### 贡献
参见 [CONTRIBUTING.md](CONTRIBUTING.md) 获取详细的贡献指南。
## 文档
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - 贡献指南和开发工作流
- **[AI_TESTING_GUIDE.md](AI_TESTING_GUIDE.md)** - 使用 AI 助手进行测试
- **[CYODA_E2E_TESTING_GUIDE.md](CYODA_E2E_TESTING_GUIDE.md)** - 端到端测试程序
- **[cyoda_mcp/README.md](cyoda_mcp/README.md)** - MCP 服务器文档
- **[docs/](docs/)** - 架构和设计文档
## 获取帮助
1. **Cyoda 平台**: [https://ai.cyoda.net](https://ai.cyoda.net)
2. **文档**: [https://docs.cyoda.net](https://docs.cyoda.net)
3. **问题**: [GitHub 问题](https://github.com/Cyoda-platform/quart-client-template/issues)
## 许可证
MIT 许可证 - 参见 [LICENSE](LICENSE) 获取详细信息
