[jira] [Created] (CAMEL-25596) Claim and configure Apache Camel on Context7, where many coding agents read library docs

["Claus Ibsen (Jira)" <ji...@apache.org>]

Claus Ibsen created CAMEL-25596:
-----------------------------------

             Summary: Claim and configure Apache Camel on Context7, where many coding agents read library docs
                 Key: CAMEL-25596
                 URL: https://issues.apache.org/jira/browse/CAMEL-25596
             Project: Camel
          Issue Type: Task
          Components: documentation
            Reporter: Claus Ibsen
             Fix For: 4.24.0


Many developers give their coding agent the [Context7|https://context7.com] MCP server for looking up library documentation, so agents often read Camel's docs from there rather than from the website. Camel is indexed on Context7, but nobody from the project has claimed or configured it. What agents get there today (checked 2026-10-12):
* Searching for "camel" ranks CAMEL-AI first ({{/camel-ai/camel}}, a Python multi-agent framework); "apache camel" finds us.
* {{/apache/camel}} (24,182 snippets, refreshed 2026-09-15) indexes the whole repository, including the generated copies of the docs under {{catalog/camel-catalog/src/generated}}, so the same doc comes up twice.
* Stale entries: the camel-core 2.16.5 javadoc from javadoc.io (23k snippets, with a high trust score), {{/apache/camel-examples}} (refreshed 2025-06-15) and {{/apache/camel-spring-boot}} (2026-07-13).
* Good: our [llms.txt|https://camel.apache.org/llms.txt] is indexed as {{/llmstxt/camel_apache_llms_txt}} (refreshed 2026-10-07).

Proposal:
# Claim {{/apache/camel}} by adding a {{context7.json}} to the repository root ([how|https://github.com/upstash/context7/blob/master/docs/howto/claiming-libraries.mdx]). A PMC member logs in to Context7 to get the public key that goes in the file.
# Use its fields:
** {{projectTitle}} and {{description}}: say "Apache Camel", so agents can tell it apart from CAMEL-AI.
** {{folders}} and {{excludeFolders}}: index each doc once (either the sources or the catalog copies) and skip tests.
** {{rules}}: what agents should follow when they use Camel. For example: Camel 4 APIs only; the canonical YAML DSL form; check component URIs and options against the catalog or the Camel MCP server instead of guessing; run and test with the Camel CLI.
** {{previousVersions}}: the supported LTS lines.
# Do the same for camel-spring-boot, camel-quarkus and the example repositories, and ask Context7 to retire or mark the camel-core 2.16.5 javadoc entry.
# Refreshing: Context7 refreshes libraries by popularity. Its GitHub Action refreshes on every push, but would need ASF Infra's allow list.

Context7 is a commercial third-party service (Upstash), so this needs a dev@ discussion before the file is added.

Related: [apache/camel#27743|https://github.com/apache/camel/pull/27743] (README link to llms.txt), CAMEL-25594, CAMEL-25595, [camel-jbang-examples#110|https://github.com/apache/camel-jbang-examples/issues/110], [camel-quarkus#9318|https://github.com/apache/camel-quarkus/issues/9318].

_Claude Code on behalf of davsclaus_




--
This message was sent by Atlassian Jira
(v8.20.10#820010)