This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cayenne-website.git
The following commit(s) were added to refs/heads/master by this push:
new 62e0120e0 latest agentic coding docs update
62e0120e0 is described below
commit 62e0120e0c314cbb556faac424352155d4cfeb29
Author: Andrus Adamchik <[email protected]>
AuthorDate: Mon May 25 10:31:24 2026 -0400
latest agentic coding docs update
---
.../site/content/docs/5.0/cayenne-guide.toc.html | 5 +-
.../docs/5.0/cayenne-guide/additional-modules.html | 2 +-
.../docs/5.0/cayenne-guide/agentic-coding.html | 5 +-
.../content/docs/5.0/cayenne-guide/ant_tasks.html | 2 +-
.../appendix-a-configuration-properties.html | 2 +-
.../appendix-b-service-collections.html | 2 +-
.../docs/5.0/cayenne-guide/build_tools.html | 2 +-
.../docs/5.0/cayenne-guide/db-first-flow.html | 2 +-
.../5.0/cayenne-guide/ext-cache-invalidation.html | 2 +-
.../content/docs/5.0/cayenne-guide/ext-crypto.html | 2 +-
.../content/docs/5.0/cayenne-guide/ext-jcache.html | 2 +-
.../content/docs/5.0/cayenne-guide/ext-osgi.html | 2 +-
.../cayenne-guide/ext-project-compatibility.html | 2 +-
.../docs/5.0/cayenne-guide/ext-velocity.html | 2 +-
.../docs/5.0/cayenne-guide/gradle_plugin.html | 2 +-
...talling-apache-cayenne-plugin-claude-code.html} | 19 +++-
.../installing-the-cayenne-mcp-server.html | 121 ++++++++++-----------
.../docs/5.0/cayenne-guide/maven_plugin.html | 2 +-
.../content/docs/5.0/cayenne-guide/mcp-tools.html | 19 ++--
.../content/docs/5.0/cayenne-guide/overview.html | 13 ++-
.../docs/5.0/cayenne-guide/re-filtering.html | 2 +-
.../docs/5.0/cayenne-guide/re-introduction.html | 2 +-
.../content/docs/5.0/cayenne-guide/re-modeler.html | 2 +-
.../re-relationships-loading-control.html | 2 +-
24 files changed, 116 insertions(+), 102 deletions(-)
diff --git a/src/main/site/content/docs/5.0/cayenne-guide.toc.html
b/src/main/site/content/docs/5.0/cayenne-guide.toc.html
index 189c57bfe..bf6731c5f 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide.toc.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide.toc.html
@@ -25,8 +25,9 @@
<li><a href="/docs/5.0/cayenne-guide/agentic-coding" class="nav-link"
id="agentic-coding">3. Agentic Coding</a>
<ul class="sectlevel2 nav">
<li><a href="/docs/5.0/cayenne-guide/overview" class="nav-link"
id="overview">3.1. Overview</a></li>
- <li><a href="/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server"
class="nav-link" id="installing-the-cayenne-mcp-server">3.2. Installing the
Cayenne MCP Server</a></li>
- <li><a href="/docs/5.0/cayenne-guide/mcp-tools" class="nav-link"
id="mcp-tools">3.3. MCP Tools</a></li>
+ <li><a
href="/docs/5.0/cayenne-guide/installing-apache-cayenne-plugin-claude-code"
class="nav-link" id="installing-apache-cayenne-plugin-claude-code">3.2.
Installing <code>apache-cayenne</code> Plugin (Claude Code)</a></li>
+ <li><a href="/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server"
class="nav-link" id="installing-the-cayenne-mcp-server">3.3. Installing the
Cayenne MCP Server</a></li>
+ <li><a href="/docs/5.0/cayenne-guide/mcp-tools" class="nav-link"
id="mcp-tools">3.4. MCP Tools</a></li>
</ul></li>
<li><a href="/docs/5.0/cayenne-guide/db-first-flow" class="nav-link"
id="db-first-flow">4. DB-First Flow</a>
<ul class="sectlevel2 nav">
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/additional-modules.html
b/src/main/site/content/docs/5.0/cayenne-guide/additional-modules.html
index 6488fe666..33181081e 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/additional-modules.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/additional-modules.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Additional Modules"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 250
+weight: 260
---
<div><h2>5. Additional Modules</h2>
<div id="index-section-toc"><ul>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/agentic-coding.html
b/src/main/site/content/docs/5.0/cayenne-guide/agentic-coding.html
index 53415803e..c550d03af 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/agentic-coding.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/agentic-coding.html
@@ -26,6 +26,7 @@ weight: 160
<div><h2>3. Agentic Coding</h2>
<div id="index-section-toc"><ul>
<li><a href="/docs/5.0/cayenne-guide/overview">3.1. Overview</a>
-<li><a href="/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server">3.2.
Installing the Cayenne MCP Server</a>
-<li><a href="/docs/5.0/cayenne-guide/mcp-tools">3.3. MCP Tools</a>
+<li><a
href="/docs/5.0/cayenne-guide/installing-apache-cayenne-plugin-claude-code">3.2.
Installing apache-cayenne Plugin (Claude Code)</a>
+<li><a href="/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server">3.3.
Installing the Cayenne MCP Server</a>
+<li><a href="/docs/5.0/cayenne-guide/mcp-tools">3.4. MCP Tools</a>
</ul></div></div>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ant_tasks.html
b/src/main/site/content/docs/5.0/cayenne-guide/ant_tasks.html
index ee192f6b7..3c9c44090 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ant_tasks.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ant_tasks.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Ant Tasks"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 350
+weight: 360
---
<div class="sect2">
<h3 id="ant_tasks"><a class="anchor" href="#ant_tasks"></a>6.3. Ant Tasks</h3>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/appendix-a-configuration-properties.html
b/src/main/site/content/docs/5.0/cayenne-guide/appendix-a-configuration-properties.html
index 2e0e1c31c..73a0d5631 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/appendix-a-configuration-properties.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/appendix-a-configuration-properties.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Appendix A. Configuration
Properties"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 360
+weight: 370
---
<div class="sect1">
<h2 id="appendix-a-configuration-properties"><a class="anchor"
href="#appendix-a-configuration-properties"></a>7. Appendix A. Configuration
Properties</h2>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/appendix-b-service-collections.html
b/src/main/site/content/docs/5.0/cayenne-guide/appendix-b-service-collections.html
index 0860c1324..913e2fe0c 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/appendix-b-service-collections.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/appendix-b-service-collections.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Appendix B. Service
Collections"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 370
+weight: 380
---
<div class="sect1">
<h2 id="appendix-b-service-collections"><a class="anchor"
href="#appendix-b-service-collections"></a>8. Appendix B. Service
Collections</h2>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/build_tools.html
b/src/main/site/content/docs/5.0/cayenne-guide/build_tools.html
index 8181ea994..993963b6c 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/build_tools.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/build_tools.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Build Tools"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 320
+weight: 330
---
<div><h2>6. Build Tools</h2>
<div id="index-section-toc"><ul>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/db-first-flow.html
b/src/main/site/content/docs/5.0/cayenne-guide/db-first-flow.html
index 6b8d7b428..03c6062e4 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/db-first-flow.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/db-first-flow.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, DB-First Flow"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 200
+weight: 210
---
<div><h2>4. DB-First Flow</h2>
<div id="index-section-toc"><ul>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/ext-cache-invalidation.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-cache-invalidation.html
index 5702e0339..5b7c4eca4 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-cache-invalidation.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-cache-invalidation.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Cache Invalidation Extension"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 260
+weight: 270
---
<div class="sect2">
<h3 id="ext-cache-invalidation"><a class="anchor"
href="#ext-cache-invalidation"></a>5.1. Cache Invalidation Extension</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ext-crypto.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-crypto.html
index 03a9901ce..fcd5d3c98 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-crypto.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-crypto.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Crypto extension"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 270
+weight: 280
---
<div class="sect2">
<h3 id="ext-crypto"><a class="anchor" href="#ext-crypto"></a>5.2. Crypto
extension</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ext-jcache.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-jcache.html
index 61cede9c5..e5df157ed 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-jcache.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-jcache.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, JCache integration"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 280
+weight: 290
---
<div class="sect2">
<h3 id="ext-jcache"><a class="anchor" href="#ext-jcache"></a>5.3. JCache
integration</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ext-osgi.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-osgi.html
index dced7f135..b2597fb5b 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-osgi.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-osgi.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Cayenne OSGI extension"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 310
+weight: 320
---
<div class="sect2">
<h3 id="ext-osgi"><a class="anchor" href="#ext-osgi"></a>5.6. Cayenne OSGI
extension</h3>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/ext-project-compatibility.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-project-compatibility.html
index 4e2ea6942..8f5e76971 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/ext-project-compatibility.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/ext-project-compatibility.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Project compatibility
extension"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 290
+weight: 300
---
<div class="sect2">
<h3 id="ext-project-compatibility"><a class="anchor"
href="#ext-project-compatibility"></a>5.4. Project compatibility extension</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ext-velocity.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-velocity.html
index b7cb4d4bc..d36219314 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-velocity.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-velocity.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Apache Velocity Extension"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 300
+weight: 310
---
<div class="sect2">
<h3 id="ext-velocity"><a class="anchor" href="#ext-velocity"></a>5.5. Apache
Velocity Extension</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/gradle_plugin.html
b/src/main/site/content/docs/5.0/cayenne-guide/gradle_plugin.html
index 65f97478d..a356b983c 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/gradle_plugin.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/gradle_plugin.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Gradle Plugin"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 340
+weight: 350
---
<div class="sect2">
<h3 id="gradle_plugin"><a class="anchor" href="#gradle_plugin"></a>6.2.
Gradle Plugin</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/overview.html
b/src/main/site/content/docs/5.0/cayenne-guide/installing-apache-cayenne-plugin-claude-code.html
similarity index 50%
copy from src/main/site/content/docs/5.0/cayenne-guide/overview.html
copy to
src/main/site/content/docs/5.0/cayenne-guide/installing-apache-cayenne-plugin-claude-code.html
index d35719ef0..c0bc9a1ef 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/overview.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/installing-apache-cayenne-plugin-claude-code.html
@@ -16,19 +16,26 @@
# specific language governing permissions and limitations
# under the License.
-title: "Cayenne Guide 5.0 · Overview"
-description: "Cayenne Guide 5.0, Overview"
+title: "Cayenne Guide 5.0 · Installing apache-cayenne Plugin (Claude Code)"
+description: "Cayenne Guide 5.0, Installing apache-cayenne Plugin (Claude
Code)"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 170
+weight: 180
---
<div class="sect2">
- <h3 id="overview"><a class="anchor" href="#overview"></a>3.1. Overview</h3>
+ <h3 id="installing-apache-cayenne-plugin-claude-code"><a class="anchor"
href="#installing-apache-cayenne-plugin-claude-code"></a>3.2. Installing
<code>apache-cayenne</code> Plugin (Claude Code)</h3>
<div class="paragraph">
- <p>AI coding agents such as Claude Code, Cursor, etc. can read and write
Cayenne projects like any other Java codebase. For day-to-day API work —
writing queries, manipulating an <code>ObjectContext</code>, etc. — you don’t
need anything Cayenne-specific. Prompt the agent the way you would for any
other project.</p>
+ <p>Install the <code>apache-cayenne</code> plugin with Cayenne-specific
skills under Claude Code:</p>
+ </div>
+ <div class="listingblock">
+ <div class="content">
+ <pre class="highlight"><code class="language-bash bash"
data-lang="bash">/plugin marketplace add apache/cayenne
+/plugin install apache-cayenne@apache-cayenne
+/reload-plugins</code></pre>
+ </div>
</div>
<div class="paragraph">
- <p>The Cayenne MCP (Model Context Protocol) server is what makes the agent
<em>Cayenne-aware</em> beyond plain source editing. It is a small stdio-based
process that the AI client launches on demand and exposes a focused set of
tools for operating on a Cayenne project descriptor. This chapter walks you
through installing the server and explains the available tools.</p>
+ <p>The plugin adds skills for DataMap editing, class generation, reverse
engineering, query writing, and runtime setup. The skills work best with the
MCP server present (see the next chapter).</p>
</div>
</div>
\ No newline at end of file
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server.html
b/src/main/site/content/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server.html
index c4ee0bfe2..92c2e85cc 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server.html
@@ -21,93 +21,84 @@ description: "Cayenne Guide 5.0, Installing the Cayenne MCP
Server"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 180
+weight: 190
---
<div class="sect2">
- <h3 id="installing-the-cayenne-mcp-server"><a class="anchor"
href="#installing-the-cayenne-mcp-server"></a>3.2. Installing the Cayenne MCP
Server</h3>
+ <h3 id="installing-the-cayenne-mcp-server"><a class="anchor"
href="#installing-the-cayenne-mcp-server"></a>3.3. Installing the Cayenne MCP
Server</h3>
<div class="paragraph">
- <p>The MCP server is a self-contained, stdio-based process that the AI
client launches on demand. It is bundled with the platform-specific
CayenneModeler and requires Java 21 or later on the system
<code>PATH</code>.</p>
+ <p>The MCP server is a self-contained, stdio-based process that the AI agent
launches on demand. It works with most agents (not only Claude). The MCP server
is bundled with the platform-specific CayenneModeler and requires Java 21 or
later on the system <code>PATH</code>. So to get it, first download the Modeler
at <a href="https://cayenne.apache.org/download/";
class="bare">https://cayenne.apache.org/download/</a> .</p>
</div>
- <div class="sect3">
- <h4 id="finding-the-jar"><a class="anchor"
href="#finding-the-jar"></a>3.2.1. Finding the JAR</h4>
- <div class="paragraph">
- <p>As mentioned above, the MCP server jar is a part if the CayenneModeler
download (available at <a href="https://cayenne.apache.org/download/";
class="bare">https://cayenne.apache.org/download/</a>). Its location depends on
the install format:</p>
+ <div class="paragraph">
+ <p>MCP runnable jar is <code>CayenneMCPServer.jar</code>. Its location is
OS-dependent (you will need this location in the next step):</p>
+ </div>
+ <div class="paragraph">
+ <p>Mac:</p>
+ </div>
+ <div class="listingblock">
+ <div class="content">
+ <pre class="highlight"><code># <install-dir> is typically
"/Applications", but it can be any other directory
+<install-dir>/CayenneModeler.app/Contents/Resources/mcp/CayenneMCPServer.jar</code></pre>
</div>
- <div class="sect4">
- <h5 id="macos"><a class="anchor" href="#macos"></a>3.2.1.1. macOS</h5>
- <div class="listingblock">
- <div class="content">
- <pre class="highlight"><code># <install-dir> is typically
"/Applications", but it can be any other directory
-<install-dir>/CayenneModeler.app/Contents/Resources/mcp/cayenne-mcp-server-<VERSION>.jar</code></pre>
- </div>
- </div>
+ </div>
+ <div class="paragraph">
+ <p>Windows:</p>
+ </div>
+ <div class="listingblock">
+ <div class="content">
+ <pre
class="highlight"><code><install-dir>\bin\CayenneMCPServer.jar</code></pre>
</div>
- <div class="sect4">
- <h5 id="windows"><a class="anchor" href="#windows"></a>3.2.1.2. Windows</h5>
- <div class="listingblock">
- <div class="content">
- <pre
class="highlight"><code><install-dir>\bin\cayenne-mcp-server-<VERSION>.jar</code></pre>
- </div>
- </div>
+ </div>
+ <div class="paragraph">
+ <p>Linux / cross-platform:</p>
+ </div>
+ <div class="listingblock">
+ <div class="content">
+ <pre
class="highlight"><code><install-dir>/bin/CayenneMCPServer.jar</code></pre>
</div>
- <div class="sect4">
- <h5 id="linux-cross-platform"><a class="anchor"
href="#linux-cross-platform"></a>3.2.1.3. Linux / cross-platform</h5>
- <div class="listingblock">
- <div class="content">
- <pre
class="highlight"><code><install-dir>/bin/cayenne-mcp-server-<VERSION>.jar</code></pre>
- </div>
+ </div>
+ <div class="paragraph">
+ <p>When installaing the MCP, replace
<code>/path/to/CayenneMCPServer.jar</code> mentioned in the instructions with
the actual jar path:</p>
+ </div>
+ <div class="sect3">
+ <h4 id="claude-code"><a class="anchor" href="#claude-code"></a>3.3.1. Claude
Code</h4>
+ <div class="listingblock">
+ <div class="content">
+ <pre class="highlight"><code class="language-bash bash" data-lang="bash">#
Register the MCP server (--scope user makes it available across all projects)
+claude mcp add cayenne --scope user -- java -jar /path/to/CayenneMCPServer.jar
+
+# Verify it is connected
+claude mcp list</code></pre>
</div>
</div>
</div>
<div class="sect3">
- <h4 id="configuring-ai-clients"><a class="anchor"
href="#configuring-ai-clients"></a>3.2.2. Configuring AI clients</h4>
+ <h4 id="cursor"><a class="anchor" href="#cursor"></a>3.3.2. Cursor</h4>
<div class="paragraph">
- <p>The server communicates over stdio and is launched on demand by the
client. In the snippets below, replace
<code>/path/to/cayenne-mcp-server-<VERSION>.jar</code> with the actual
jar path from the previous section.</p>
- </div>
- <div class="sect4">
- <h5 id="claude-code"><a class="anchor" href="#claude-code"></a>3.2.2.1.
Claude Code</h5>
- <div class="paragraph">
- <p>By default <code>claude mcp add</code> registers the server for the
current project only. Use <code>--scope user</code> to make it available across
all projects for your OS user:</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="highlight"><code class="language-bash bash"
data-lang="bash"># Current project only
-claude mcp add cayenne -- java -jar
/path/to/cayenne-mcp-server-<VERSION>.jar
-
-# All projects for the current user
-claude mcp add cayenne --scope user -- java -jar
/path/to/cayenne-mcp-server-<VERSION>.jar</code></pre>
- </div>
- </div>
+ <p>Edit <code>~/.cursor/mcp.json</code> (global, all projects) or
<code>.cursor/mcp.json</code> in your project (per-project):</p>
</div>
- <div class="sect4">
- <h5 id="cursor"><a class="anchor" href="#cursor"></a>3.2.2.2. Cursor</h5>
- <div class="paragraph">
- <p>Edit <code>~/.cursor/mcp.json</code> (global, all projects) or
<code>.cursor/mcp.json</code> in your project (per-project):</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="highlight"><code class="language-json json" data-lang="json">{
+ <div class="listingblock">
+ <div class="content">
+ <pre class="highlight"><code class="language-json json" data-lang="json">{
"mcpServers": {
"cayenne": {
"command": "java",
- "args": ["-jar", "/path/to/cayenne-mcp-server-<VERSION>.jar"]
+ "args": ["-jar", "/path/to/CayenneMCPServer.jar"]
}
}
}</code></pre>
- </div>
</div>
</div>
- <div class="sect4">
- <h5 id="codex"><a class="anchor" href="#codex"></a>3.2.2.3. Codex</h5>
- <div class="paragraph">
- <p>Add a <code>[mcp_servers.cayenne]</code> entry to
<code>~/.codex/config.toml</code>:</p>
- </div>
- <div class="listingblock">
- <div class="content">
- <pre class="highlight"><code class="language-toml toml"
data-lang="toml">[mcp_servers.cayenne]
+ </div>
+ <div class="sect3">
+ <h4 id="codex"><a class="anchor" href="#codex"></a>3.3.3. Codex</h4>
+ <div class="paragraph">
+ <p>Add a <code>[mcp_servers.cayenne]</code> entry to
<code>~/.codex/config.toml</code>:</p>
+ </div>
+ <div class="listingblock">
+ <div class="content">
+ <pre class="highlight"><code class="language-toml toml"
data-lang="toml">[mcp_servers.cayenne]
command = "java"
-args = ["-jar", "/path/to/cayenne-mcp-server-<VERSION>.jar"]</code></pre>
- </div>
+args = ["-jar", "/path/to/CayenneMCPServer.jar"]</code></pre>
</div>
</div>
</div>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/maven_plugin.html
b/src/main/site/content/docs/5.0/cayenne-guide/maven_plugin.html
index de74a083e..f01491e7c 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/maven_plugin.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/maven_plugin.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Maven Plugin"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 330
+weight: 340
---
<div class="sect2">
<h3 id="maven_plugin"><a class="anchor" href="#maven_plugin"></a>6.1. Maven
Plugin</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/mcp-tools.html
b/src/main/site/content/docs/5.0/cayenne-guide/mcp-tools.html
index 09d4be207..bf4454726 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/mcp-tools.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/mcp-tools.html
@@ -21,15 +21,18 @@ description: "Cayenne Guide 5.0, MCP Tools"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 190
+weight: 200
---
<div class="sect2">
- <h3 id="mcp-tools"><a class="anchor" href="#mcp-tools"></a>3.3. MCP Tools</h3>
+ <h3 id="mcp-tools"><a class="anchor" href="#mcp-tools"></a>3.4. MCP Tools</h3>
<div class="paragraph">
- <p>The server exposes three tools. Your agent will discover them on its own,
but it is useful to understand the capabilities and possible prompts. All tools
operate on a Cayenne project descriptor (a <code>cayenne-*.xml</code> file) and
take absolute paths - agents should resolve relative paths against the current
workspace before invoking.</p>
+ <p>The server exposes three tools. Your agent will discover them on its own,
but it is useful to understand the capabilities and possible prompts. All tools
operate on a Cayenne project descriptor (a <code>cayenne-*.xml</code> file) and
take absolute paths — agents should resolve relative paths against the current
workspace before invoking.</p>
+ </div>
+ <div class="paragraph">
+ <p>If you are using the <code>apache-cayenne</code> Claude Code plugin, its
skills (<code>cayenne-cgen</code>, <code>cayenne-modeler</code>,
<code>cayenne-db-import</code>) call these tools automatically. You can verify
the server is available with <code>claude mcp list</code> — look for an entry
named <code>cayenne</code>.</p>
</div>
<div class="sect3">
- <h4 id="open_project"><a class="anchor" href="#open_project"></a>3.3.1.
open_project</h4>
+ <h4 id="open_project"><a class="anchor" href="#open_project"></a>3.4.1.
open_project</h4>
<div class="paragraph">
<p>Launches CayenneModeler with the given project file pre-loaded. The call
is non-blocking; the server waits for the Modeler to confirm a successful
project load via a short startup handshake, then returns.</p>
</div>
@@ -82,7 +85,7 @@ weight: 190
</div>
</div>
<div class="sect3">
- <h4 id="cgen_run"><a class="anchor" href="#cgen_run"></a>3.3.2. cgen_run</h4>
+ <h4 id="cgen_run"><a class="anchor" href="#cgen_run"></a>3.4.2. cgen_run</h4>
<div class="paragraph">
<p>Runs the Cayenne class generator (<code>cgen</code>) for a single
DataMap inside the project, using the <code>cgen</code> configuration stored in
the DataMap XML. The tool returns a JSON report describing which files were
written, which were already up-to-date, and any errors encountered.</p>
</div>
@@ -143,12 +146,12 @@ weight: 190
</div>
</div>
<div class="sect3">
- <h4 id="dbimport_run"><a class="anchor" href="#dbimport_run"></a>3.3.3.
dbimport_run</h4>
+ <h4 id="dbimport_run"><a class="anchor" href="#dbimport_run"></a>3.4.3.
dbimport_run</h4>
<div class="paragraph">
- <p>Runs Cayenne reverse engineering (dbimport) for a single DataMap inside
the project. The tool reads the JDBC connection from the DBConnector that
CayenneModeler stored in preferences when the user last ran the
reverse-engineering dialog for this DataMap. If the DataMap has a
<code><reverse-engineering></code> block its filters are applied;
otherwise the full database schema is imported. The DataMap XML is rewritten on
disk with the merged schema, and a JSON summary of what ch [...]
+ <p>Runs Cayenne reverse engineering (dbimport) for a single DataMap inside
the project. The tool reads the JDBC connection from CayenneModeler preferences
on the local machine (the agent doesn’t see the credentials). If the DataMap
has a <code><reverse-engineering></code> block its filters are applied;
otherwise the full database schema is imported. The DataMap XML is rewritten on
disk with the merged schema, and a JSON summary of what changed is returned.</p>
</div>
<div class="paragraph">
- <p>JDBC credentials are not passed as arguments — they come from
CayenneModeler preferences. If no connection has been saved yet
(<code>dbconnector_not_configured</code> error), open the project in the
Modeler with <code>open_project</code>, run the dialog once to save the
connection, then call <code>dbimport_run</code> again.</p>
+ <p>If no connection has been saved yet
(<code>dbconnector_not_configured</code> error), open the project in the
Modeler with <code>open_project</code>, run the dialog once to save the
connection, then call <code>dbimport_run</code> again.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/overview.html
b/src/main/site/content/docs/5.0/cayenne-guide/overview.html
index d35719ef0..d5a68653b 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/overview.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/overview.html
@@ -29,6 +29,17 @@ weight: 170
<p>AI coding agents such as Claude Code, Cursor, etc. can read and write
Cayenne projects like any other Java codebase. For day-to-day API work —
writing queries, manipulating an <code>ObjectContext</code>, etc. — you don’t
need anything Cayenne-specific. Prompt the agent the way you would for any
other project.</p>
</div>
<div class="paragraph">
- <p>The Cayenne MCP (Model Context Protocol) server is what makes the agent
<em>Cayenne-aware</em> beyond plain source editing. It is a small stdio-based
process that the AI client launches on demand and exposes a focused set of
tools for operating on a Cayenne project descriptor. This chapter walks you
through installing the server and explains the available tools.</p>
+ <p>Two additional elements make the agent <em>Cayenne-aware</em> beyond
plain source editing:</p>
+ </div>
+ <div class="ulist">
+ <ul>
+ <li>
+ <p>MCP server — a small stdio-based process the agent launches on demand,
exposing tools for class generation, DB import, and opening CayenneModeler.
Works with any MCP-compatible client (Claude Code, Cursor, Codex,
etc.).</p></li>
+ <li>
+ <p><code>apache-cayenne</code> Claude Code plugin — a Claude Code-specific
extension that bundles pre-built skills for DataMap editing, query writing,
runtime setup, and more. The skills detect the MCP server at runtime;</p></li>
+ </ul>
+ </div>
+ <div class="paragraph">
+ <p>Both elements are independent but work best together. This chapter walks
you through installing both and explains the available MCP tools.</p>
</div>
</div>
\ No newline at end of file
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/re-filtering.html
b/src/main/site/content/docs/5.0/cayenne-guide/re-filtering.html
index 4890328db..0c3d693f7 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/re-filtering.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/re-filtering.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Filtering"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 220
+weight: 230
---
<div class="sect2">
<h3 id="re-filtering"><a class="anchor" href="#re-filtering"></a>4.2.
Filtering</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/re-introduction.html
b/src/main/site/content/docs/5.0/cayenne-guide/re-introduction.html
index 2f716f391..e0e732b9f 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/re-introduction.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/re-introduction.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Introduction"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 210
+weight: 220
---
<div class="sect2">
<h3 id="re-introduction"><a class="anchor" href="#re-introduction"></a>4.1.
Introduction</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/re-modeler.html
b/src/main/site/content/docs/5.0/cayenne-guide/re-modeler.html
index f45642f61..66805a1ba 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/re-modeler.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/re-modeler.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Reverse Engineering in
Cayenne Modeler"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 240
+weight: 250
---
<div class="sect2">
<h3 id="re-modeler"><a class="anchor" href="#re-modeler"></a>4.4. Reverse
Engineering in Cayenne Modeler</h3>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/re-relationships-loading-control.html
b/src/main/site/content/docs/5.0/cayenne-guide/re-relationships-loading-control.html
index b7038e5d6..f74c9015c 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/re-relationships-loading-control.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/re-relationships-loading-control.html
@@ -21,7 +21,7 @@ description: "Cayenne Guide 5.0, Other Settings"
cayenneVersion: "5.0"
cayenneNoToc: true
docId: cayenne-guide
-weight: 230
+weight: 240
---
<div class="sect2">
<h3 id="re-relationships-loading-control"><a class="anchor"
href="#re-relationships-loading-control"></a>4.3. Other Settings</h3>
