This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-jbang-examples.git
The following commit(s) were added to refs/heads/main by this push:
new db49cd0 docs: point coding agents to llms.txt and the Camel MCP
server (#111)
db49cd0 is described below
commit db49cd0d46b50895510c4426a6ae1521e14bf306
Author: Shivansh Goel <[email protected]>
AuthorDate: Tue Oct 13 20:19:04 2026 +0530
docs: point coding agents to llms.txt and the Camel MCP server (#111)
Signed-off-by: SHIVANSH-ux-ys <[email protected]>
---
AGENTS.md | 11 +++++++++++
README.md | 2 ++
2 files changed, 13 insertions(+)
diff --git a/AGENTS.md b/AGENTS.md
index dfaa2a8..7589493 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -1,5 +1,16 @@
# Apache Camel JBang Examples - AI Agent Guidelines
+## Building an integration from these examples
+
+If you are using these examples to build an Apache Camel integration:
+
+- Apache Camel LLM index: https://camel.apache.org/llms.txt
+- Any Apache Camel documentation page is available as LLM-friendly Markdown by
replacing `.html` with `.md` in its URL.
+- 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-jbang-examples**.
This repository hosts low-code Apache Camel integrations that run from the
diff --git a/README.md b/README.md
index 07cbbbb..290139b 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@ with the Enterprise Integration Patterns and 350+ components.
These examples sho
route needs, sends it a message, and runs its tests. No Maven, no Gradle, no
Java project; a route is a YAML
file and a command.
+For AI coding agents: start at [llms.txt](https://camel.apache.org/llms.txt),
documentation pages are also available as Markdown (replace `.html` with `.md`
in the URL), and the [Camel MCP
server](https://camel.apache.org/manual/camel-jbang-mcp.html) looks up
components and their options and validates routes.
+
## Install the Camel CLI
Install [JBang](https://www.jbang.dev/download/), then the CLI:
