davsclaus opened a new issue, #110:
URL: https://github.com/apache/camel-jbang-examples/issues/110

   People, and the coding agents they use, often come straight to this 
repository to look at working examples instead of starting on the website. 
Nothing here tells an agent where Camel's documentation for agents is:
   
   - The README doesn't link https://camel.apache.org/llms.txt or the [Camel 
MCP server](https://camel.apache.org/manual/camel-jbang-mcp.html). Its MCP 
mentions are about the example that exposes routes as MCP tools.
   - `AGENTS.md` is a guide for contributing examples 
([CAMEL-23823](https://issues.apache.org/jira/browse/CAMEL-23823)). An agent 
that reads it while building its own integration from an example learns nothing 
about where to look things up.
   
   Proposal:
   
   1. **README:** a line near the top for coding agents: start at 
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.
   2. **AGENTS.md:** a short section at the top for agents that build an 
integration 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)).
 The rest of the file stays the contributor guide.
   
   GitHub's About sidebar holds only one link (the website), so the README is 
where the pointer has to go. apache/camel#27743 does the same for the 
apache/camel README.
   
   _Claude Code on behalf of davsclaus_
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)
   


-- 
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]

Reply via email to