Claus Ibsen created CAMEL-25594:
-----------------------------------
Summary: camel-spring-boot-examples - point coding agents to
llms.txt and the Camel MCP server from the README and AGENTS.md
Key: CAMEL-25594
URL: https://issues.apache.org/jira/browse/CAMEL-25594
Project: Camel
Issue Type: Task
Components: examples
Reporter: Claus Ibsen
Fix For: 4.24.0
People, and the coding agents they use, often come straight to
[camel-spring-boot-examples|https://github.com/apache/camel-spring-boot-examples]
to look at working examples instead of starting on the website. Nothing there
tells an agent where the documentation for agents is:
* The README links neither [llms.txt|https://camel.apache.org/llms.txt] nor the
[Camel MCP server|https://camel.apache.org/manual/camel-jbang-mcp.html].
* {{AGENTS.md}} is a guide for contributing examples (CAMEL-23823).
Proposal:
# *README:* a line near the top for coding agents:
[llms.txt|https://camel.apache.org/llms.txt] for Camel itself and the [Camel
Spring Boot docs|https://camel.apache.org/camel-spring-boot/latest/] for the
starters. Pages on both are also available as Markdown (replace {{.html}} with
{{.md}}). The Camel MCP server looks up components and their options and
validates routes.
# *AGENTS.md:* a short section at the top for agents that build an application
from these examples, with the same advice as the {{AGENTS.md}} that {{camel
export}} and the Camel Maven archetypes generate
([template|https://github.com/apache/camel/blob/main/dsl/camel-jbang/camel-jbang-core/src/main/resources/templates/agents.md.ftl]),
plus the Camel Spring Boot docs. The rest of the file stays the contributor
guide.
GitHub issues are turned off on that repository, hence this JIRA. GitHub's
About sidebar holds only one link (the website), so the README is where the
pointer has to go.
[apache/camel#27743|https://github.com/apache/camel/pull/27743] does the same
for the apache/camel README.
_Claude Code on behalf of davsclaus_
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
