This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch camel-quarkus-main
in repository https://gitbox.apache.org/repos/asf/camel-quarkus-examples.git
The following commit(s) were added to refs/heads/camel-quarkus-main by this
push:
new c826bd7b Point coding agents to the docs and the Camel MCP server
(#601)
c826bd7b is described below
commit c826bd7b3d2fcf891be47cea7cdd0bdbd69a8cfd
Author: Shivansh Goel <[email protected]>
AuthorDate: Tue Oct 13 20:27:16 2026 +0530
Point coding agents to the docs and the Camel MCP server (#601)
Signed-off-by: SHIVANSH-ux-ys <[email protected]>
---
AGENTS.md | 12 ++++++++++++
README.adoc | 6 ++++++
2 files changed, 18 insertions(+)
diff --git a/AGENTS.md b/AGENTS.md
index 6c4cbaab..ccd4b192 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -1,5 +1,17 @@
# Apache Camel Quarkus Examples - AI Agent Guidelines
+## Building an application from these examples
+
+If you are using these examples to build a Camel Quarkus application:
+
+- Apache Camel LLM index: https://camel.apache.org/llms.txt
+- Camel Quarkus documentation and extensions:
https://camel.apache.org/camel-quarkus/latest/
+- Any Apache Camel or Camel Quarkus documentation page is available as
LLM-friendly Markdown by replacing `.html` with `.md` in its URL (for example,
https://camel.apache.org/camel-quarkus/latest/reference/extensions/kafka.md).
+- Prefer the Camel CLI and the [Camel MCP
server](https://camel.apache.org/manual/camel-jbang-mcp.html) (linked from the
index above) to inspect components, their endpoint options and the catalog. Do
not invent component URIs or options — verify them against the catalog or
documentation.
+- If your project uses the YAML DSL, write routes in the canonical YAML DSL
format, and use the Camel MCP server to validate their structure.
+
+## Contributing examples to this repository
+
Guidelines for AI agents contributing examples to
**apache/camel-quarkus-examples**.
This repository contains runnable example applications that demonstrate Apache
diff --git a/README.adoc b/README.adoc
index 719ca06b..8afa0822 100644
--- a/README.adoc
+++ b/README.adoc
@@ -8,6 +8,12 @@ Useful links:
*
https://camel.apache.org/camel-quarkus/latest/contributor-guide/index.html[Camel
Quarkus Contributor guide]
* https://github.com/apache/camel-quarkus[Camel Quarkus source repository]
+== AI integration
+
+AI coding assistants can read the documentation as Markdown:
https://camel.apache.org/llms.txt[llms.txt] indexes the Apache Camel
documentation, and the https://camel.apache.org/camel-quarkus/latest/[Camel
Quarkus documentation] covers the extensions. Pages on both are also available
as Markdown by replacing `.html` with `.md` in the URL (for example,
https://camel.apache.org/camel-quarkus/latest/reference/extensions/kafka.md).
+
+The https://camel.apache.org/manual/camel-jbang-mcp.html[Camel MCP server]
looks up components and their options and validates routes.
+
== Feedback
Please report bugs and propose improvements via
https://github.com/apache/camel-quarkus/issues[GitHub issues of Camel Quarkus]
project.
