跳转到内容
AggregaAggrega
选择语言: 简体中文
本页面由机器翻译。阅读英文原文。

编写指南

本指南是架构章节和语言参考的实践配套。架构章节解释 Aggrega 为什么是现在的样子,参考文档规定每个字段是什么含义,而本指南教你如何动手编写——该选用哪个实体、按什么顺序编写,以及 CLI 和 AI 助手如何帮助你以最少的阻力得到正确的文件。

本指南同时面向两类读者:在编辑器中手动编写的人,以及通过 Model Context Protocol 服务器代表人进行编写的 AI 助手。两者遵循同一个循环,阅读同样的参考内容,因此以下页面对两者都适用。

阅读顺序

  1. 编写 Aggrega 文件——端到端的编写循环:选择你的角色、了解结构、生成脚手架、填写、验证、构建。从这里开始。
  2. 角色——四种协作的编写角色(开发者、架构师、运维、操作员),以及其背后“指导而非强制”的框架。
  3. 按角色划分的实体——每种实体类型都对应到通常负责它的角色,让你知道每项关注点应放在哪个文件中。
  4. 安装——安装 aggrega 二进制文件,最先给出命令;其中的连接部分指向连接 MCP 服务器。
  5. 在 Visual Studio Code 中使用 Aggrega——适用于 Visual Studio Code 的 Aggrega 扩展:它的运行要求、欢迎页、各个面板和拓扑图,以及所有设置和命令。

导入从你已有的另一种格式的项目出发,据此起草这些文件,供你审阅和构建。

学习 Aggrega将本指南置于一条贯穿整个文档的路径之中。

使用 AI 助手

  1. 借助 AI 助手设置 Aggrega——一段可粘贴到能运行命令的助手中的提示词,让它安装 Aggrega、添加 Aggrega 技能并将自身连接到服务器。
  2. 连接 MCP 服务器——逐个客户端给出的服务器条目、每个客户端将其保存在何处、通过 HTTPS 访问的服务器,以及如何检查连接。
  3. Aggrega 技能——助手为 Aggrega 加载的指令:如何安装这些指令并使其保持最新。
  4. 你的助手可以用 Aggrega 做什么——连接后的服务器允许助手读取、检查、构建和发布哪些内容。

助手的各项功能与本指南的关系

aggrega mcp 服务器将本指南、语言参考和 JSON Schema 作为资源公开,供助手在编写 YAML 之前阅读,此外还提供用于生成实体脚手架和验证实体的工具。助手内置的编写提示会指回这些页面,而不是重复其内容,因此本指南是编写方法唯一的文字说明所在。编写循环请参见编写 Aggrega 文件,连接方式请参见连接 MCP 服务器。