Claus Ibsen created CAMEL-25595:
-----------------------------------
Summary: camel-examples - point coding agents to llms.txt and the
Camel MCP server from the README and a new AGENTS.md
Key: CAMEL-25595
URL: https://issues.apache.org/jira/browse/CAMEL-25595
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-examples|https://github.com/apache/camel-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].
* There is no {{AGENTS.md}}. CAMEL-23823 added one to the other three example
repositories, but not to this one.
Proposal:
# *README:* a line near the top for coding agents: start at
[llms.txt|https://camel.apache.org/llms.txt], documentation pages are also
available as Markdown (replace {{.html}} with {{.md}}), and the Camel MCP
server looks up components and their options and validates routes.
# *AGENTS.md:* add one that starts 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]).
It can also carry a contributor guide like the ones the other example
repositories got in CAMEL-23823.
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)
