Skip to content

CAMEL-25595: add AGENTS.md and point coding agents to llms.txt and Camel MCP server - #296

Open
gnodet wants to merge 2 commits into
mainfrom
CAMEL-25595-agents-md
Open

gnodet wants to merge 2 commits into
mainfrom
CAMEL-25595-agents-md

Conversation

@gnodet

@gnodet gnodet commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

AI coding assistants pointed at this repository have no dedicated guidance file and no link to the
Camel documentation index for agents. The equivalent work was done for apache/camel in PR #27743
and for other Camel example repos (CAMEL-23823).

Changes

  • AGENTS.md (new) — root-level guidance for AI coding assistants:
    points to llms.txt, the Camel MCP server, explains the repository layout,
    build & run steps, writing conventions, and commit/PR conventions.
  • README.adoc — new AI coding assistants section after the introduction,
    with links to AGENTS.md, llms.txt, and the Camel MCP server.
    Also notes the .html→.md trick for getting any doc page as Markdown.

The AGENTS.md content is adapted from the template at
dsl/camel-jbang/camel-jbang-run/src/main/resources/templates/agents.md.ftl
in apache/camel, extended with examples-specific layout and build instructions.

Hermes Agent (Claude Sonnet 4.6) on behalf of Guillaume Nodet

@gnodet
gnodet requested review from apupier and davsclaus November 12, 2026 08:53
@gnodet gnodet self-assigned this Nov 12, 2026
@gnodet gnodet added this to the 4.24.0 milestone Nov 12, 2026
@gnodet

gnodet commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

The CI failure (semantic-agent-routing RoutingTest: Unknown property 'question' in semantic declaration) is pre-existing and unrelated to this PR — the same test fails on main itself in the last 3 consecutive CI runs (runs #43163238337, #42967571100, #42763862424). This PR only adds AGENTS.md and modifies README.adoc; no Java or test code is touched.

@gnodet gnodet added the documentation Improvements or additions to documentation label Nov 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant