luigidemasi commented on code in PR #189: URL: https://github.com/apache/camel-kit/pull/189#discussion_r4615834129
########## docs/modules/ROOT/pages/architecture.adoc: ########## @@ -59,6 +58,45 @@ front matter against it. See xref:skills.adoc[], xref:mcp.adoc[], xref:knowledge.adoc[], xref:graph.adoc[] and xref:forage.adoc[] for each layer. +[[camel-yaml-guidance]] +=== Camel YAML DSL guidance + +The development snapshot includes fifteen Camel 4.22 YAML DSL rules in the generated agent instructions. These rules +cover placement and value types, `routeConfiguration`, HTTP and mail headers, dependency loading, and ActiveMQ +acknowledgement modes. The +https://github.com/apache/camel-kit/blob/main/kit/camel-kit-core/src/main/resources/templates/shared/agents-md.md#camel-422-rules[maintained +rule list] lives in the shared template and is copied into agent-specific templates during the build. + +**Coverage by agent:** + +* *Claude Code, Bob 2, Qwen, OpenCode*: Use the shared template (`templates/shared/agents-md.md`). These agents load +the rules from their entry file (`CLAUDE.md`, `AGENTS.md`, `QWEN.md`) immediately when the project is opened, before +any skill invocation. +* *Antigravity, Codex CLI, GitHub Copilot CLI, Pi*: Use agent-specific templates +(`templates/{antigravity,codex,copilot,pi}/agents-md.md`) that include the same rule set. Loading behavior varies: +** *Antigravity and Codex CLI*: Rules are available from `AGENTS.md` when the project is opened. +** *GitHub Copilot CLI*: Rules load from `.github/copilot-instructions.md` on first invocation or when the +instructions are refreshed. Review Comment: **P2** A fresh Copilot init put all fifteen rules in root `AGENTS.md`. The generated `.github/copilot-instructions.md` contains the general project instructions and zero YAML DSL rules. [Copilot instruction discovery](https://docs.github.com/en/copilot/how-tos/copilot-cli/customize-copilot/add-custom-instructions) ```suggestion ** *GitHub Copilot CLI*: Copilot discovers the fifteen rules in the repository-root `AGENTS.md` alongside its repository-wide `.github/copilot-instructions.md`. ``` _AI-generated by Codex on behalf of @luigidemasi._ ########## docs/modules/ROOT/pages/architecture.adoc: ########## @@ -59,6 +58,45 @@ front matter against it. See xref:skills.adoc[], xref:mcp.adoc[], xref:knowledge.adoc[], xref:graph.adoc[] and xref:forage.adoc[] for each layer. +[[camel-yaml-guidance]] +=== Camel YAML DSL guidance + +The development snapshot includes fifteen Camel 4.22 YAML DSL rules in the generated agent instructions. These rules +cover placement and value types, `routeConfiguration`, HTTP and mail headers, dependency loading, and ActiveMQ +acknowledgement modes. The +https://github.com/apache/camel-kit/blob/main/kit/camel-kit-core/src/main/resources/templates/shared/agents-md.md#camel-422-rules[maintained +rule list] lives in the shared template and is copied into agent-specific templates during the build. + +**Coverage by agent:** + +* *Claude Code, Bob 2, Qwen, OpenCode*: Use the shared template (`templates/shared/agents-md.md`). These agents load +the rules from their entry file (`CLAUDE.md`, `AGENTS.md`, `QWEN.md`) immediately when the project is opened, before +any skill invocation. +* *Antigravity, Codex CLI, GitHub Copilot CLI, Pi*: Use agent-specific templates +(`templates/{antigravity,codex,copilot,pi}/agents-md.md`) that include the same rule set. Loading behavior varies: +** *Antigravity and Codex CLI*: Rules are available from `AGENTS.md` when the project is opened. +** *GitHub Copilot CLI*: Rules load from `.github/copilot-instructions.md` on first invocation or when the +instructions are refreshed. +** *Pi*: Rules are loaded when Pi reads `AGENTS.md` as project context, typically on first skill invocation or when +the project is explicitly trusted. + +**Schema validation vs. runtime verification:** + +Rule 4 instructs the agent to run `camel validate` on the final YAML file after the last edit. This validates the Review Comment: **P2** On Camel 4.22.1, bare `camel validate` printed help and exited 0. Adding only the filename exited 2. With the validate plugin installed, `camel validate yaml <file>` accepted a valid route and rejected an invalid one. Rule 4 also offers the MCP tool. [Camel 4.22.1 command reference](https://github.com/apache/camel/blob/camel-4.22.1/docs/user-manual/modules/ROOT/pages/jbang-commands/camel-jbang-validate-yaml.adoc) ```suggestion Rule 4 calls for schema validation after the final edit. Use `camel_validate_yaml_dsl` or, with the validate plugin installed, run `camel validate yaml <file>`. This validates the ``` _AI-generated by Codex on behalf of @luigidemasi._ ########## docs/modules/ROOT/pages/architecture.adoc: ########## @@ -59,6 +58,45 @@ front matter against it. See xref:skills.adoc[], xref:mcp.adoc[], xref:knowledge.adoc[], xref:graph.adoc[] and xref:forage.adoc[] for each layer. +[[camel-yaml-guidance]] +=== Camel YAML DSL guidance + +The development snapshot includes fifteen Camel 4.22 YAML DSL rules in the generated agent instructions. These rules +cover placement and value types, `routeConfiguration`, HTTP and mail headers, dependency loading, and ActiveMQ +acknowledgement modes. The +https://github.com/apache/camel-kit/blob/main/kit/camel-kit-core/src/main/resources/templates/shared/agents-md.md#camel-422-rules[maintained +rule list] lives in the shared template and is copied into agent-specific templates during the build. + +**Coverage by agent:** + +* *Claude Code, Bob 2, Qwen, OpenCode*: Use the shared template (`templates/shared/agents-md.md`). These agents load +the rules from their entry file (`CLAUDE.md`, `AGENTS.md`, `QWEN.md`) immediately when the project is opened, before +any skill invocation. Review Comment: **P2** Please give Qwen its own loading description. In Qwen Code 0.25.3, the project context loader read neither project file with folder trust off. With trust on it read both `QWEN.md` and `AGENTS.md`. The rules are in `AGENTS.md`; the generated `QWEN.md` points readers there. [Qwen loader](https://github.com/QwenLM/qwen-code/blob/v0.25.3/packages/core/src/memory/memoryDiscovery.ts#L160) _AI-generated by Codex on behalf of @luigidemasi._ ########## docs/modules/ROOT/pages/architecture.adoc: ########## @@ -59,6 +58,45 @@ front matter against it. See xref:skills.adoc[], xref:mcp.adoc[], xref:knowledge.adoc[], xref:graph.adoc[] and xref:forage.adoc[] for each layer. +[[camel-yaml-guidance]] +=== Camel YAML DSL guidance + +The development snapshot includes fifteen Camel 4.22 YAML DSL rules in the generated agent instructions. These rules +cover placement and value types, `routeConfiguration`, HTTP and mail headers, dependency loading, and ActiveMQ +acknowledgement modes. The +https://github.com/apache/camel-kit/blob/main/kit/camel-kit-core/src/main/resources/templates/shared/agents-md.md#camel-422-rules[maintained +rule list] lives in the shared template and is copied into agent-specific templates during the build. + +**Coverage by agent:** + +* *Claude Code, Bob 2, Qwen, OpenCode*: Use the shared template (`templates/shared/agents-md.md`). These agents load +the rules from their entry file (`CLAUDE.md`, `AGENTS.md`, `QWEN.md`) immediately when the project is opened, before +any skill invocation. +* *Antigravity, Codex CLI, GitHub Copilot CLI, Pi*: Use agent-specific templates +(`templates/{antigravity,codex,copilot,pi}/agents-md.md`) that include the same rule set. Loading behavior varies: +** *Antigravity and Codex CLI*: Rules are available from `AGENTS.md` when the project is opened. +** *GitHub Copilot CLI*: Rules load from `.github/copilot-instructions.md` on first invocation or when the +instructions are refreshed. +** *Pi*: Rules are loaded when Pi reads `AGENTS.md` as project context, typically on first skill invocation or when +the project is explicitly trusted. Review Comment: **P2** The pinned Pi 0.84.2 opened the generated `AGENTS.md` at startup with project trust denied and skills disabled. Disabling context-file discovery suppressed the read. [Pi context files](https://github.com/earendil-works/pi/blob/914cf1472e715297caa30db4b9535d534a9eb718/packages/coding-agent/README.md#context-files) ```suggestion ** *Pi*: Pi loads the root `AGENTS.md` as project context at startup, before project trust or skill invocation. ``` _AI-generated by Codex on behalf of @luigidemasi._ ########## docs/modules/ROOT/pages/architecture.adoc: ########## @@ -59,6 +58,45 @@ front matter against it. See xref:skills.adoc[], xref:mcp.adoc[], xref:knowledge.adoc[], xref:graph.adoc[] and xref:forage.adoc[] for each layer. +[[camel-yaml-guidance]] +=== Camel YAML DSL guidance + +The development snapshot includes fifteen Camel 4.22 YAML DSL rules in the generated agent instructions. These rules +cover placement and value types, `routeConfiguration`, HTTP and mail headers, dependency loading, and ActiveMQ +acknowledgement modes. The +https://github.com/apache/camel-kit/blob/main/kit/camel-kit-core/src/main/resources/templates/shared/agents-md.md#camel-422-rules[maintained +rule list] lives in the shared template and is copied into agent-specific templates during the build. Review Comment: **P3** The Antigravity, Codex, Copilot and Pi templates each contain a checked-in copy. I compared the four packaged templates with their respective source files. Editing the shared list alone leaves those four copies unchanged. ```suggestion rule list] lives in the shared template. The four agent-specific templates each maintain a copy. ``` _AI-generated by Codex on behalf of @luigidemasi._ -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
