This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/cayenne-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new e42b86f96 agentic coding update
e42b86f96 is described below
commit e42b86f96ea301b1807103c38b1f205dcb2fc791
Author: Andrus Adamchik <[email protected]>
AuthorDate: Mon May 25 10:50:47 2026 -0400
agentic coding update
---
.../cayenne-guide/additional-modules/index.html | 8 -
docs/5.0/cayenne-guide/agentic-coding/index.html | 8 -
docs/5.0/cayenne-guide/ant_tasks/index.html | 8 -
.../apache-cayenne-claude-code-plugin/index.html | 12 +-
.../appendix-a-configuration-properties/index.html | 8 -
.../appendix-b-service-collections/index.html | 8 -
docs/5.0/cayenne-guide/build_tools/index.html | 8 -
.../5.0/cayenne-guide/cayenne-framework/index.html | 8 -
.../cayenne-mapping-structure/index.html | 8 -
.../cayenne-guide/cayenne-mcp-server/index.html | 12 +-
docs/5.0/cayenne-guide/cayenne-modeler/index.html | 8 -
docs/5.0/cayenne-guide/commit-log/index.html | 8 -
.../customizing-cayenne-runtime/index.html | 8 -
docs/5.0/cayenne-guide/db-first-flow/index.html | 12 +-
docs/5.0/cayenne-guide/expressions/index.html | 8 -
.../ext-cache-invalidation/index.html | 12 +-
docs/5.0/cayenne-guide/ext-commit-log/index.html | 549 -----------------
docs/5.0/cayenne-guide/ext-crypto/index.html | 8 -
docs/5.0/cayenne-guide/ext-jcache/index.html | 8 -
docs/5.0/cayenne-guide/ext-osgi/index.html | 8 -
.../ext-project-compatibility/index.html | 8 -
docs/5.0/cayenne-guide/ext-velocity/index.html | 8 -
docs/5.0/cayenne-guide/gradle_plugin/index.html | 8 -
.../including-cayenne-in-project/index.html | 8 -
.../index.html | 483 ---------------
.../installing-the-cayenne-mcp-server/index.html | 547 -----------------
docs/5.0/cayenne-guide/lifecycle-events/index.html | 8 -
docs/5.0/cayenne-guide/maven_plugin/index.html | 8 -
docs/5.0/cayenne-guide/mcp-tools/index.html | 654 ---------------------
.../index.html | 8 -
docs/5.0/cayenne-guide/orderings/index.html | 8 -
docs/5.0/cayenne-guide/overview/index.html | 8 -
.../cayenne-guide/performance-tuning/index.html | 8 -
.../persistent-objects-objectcontext/index.html | 8 -
docs/5.0/cayenne-guide/queries/index.html | 8 -
docs/5.0/cayenne-guide/re-filtering/index.html | 8 -
docs/5.0/cayenne-guide/re-introduction/index.html | 8 -
docs/5.0/cayenne-guide/re-modeler/index.html | 8 -
.../re-relationships-loading-control/index.html | 8 -
docs/5.0/cayenne-guide/setup/index.html | 8 -
docs/5.0/cayenne-guide/starting-cayenne/index.html | 8 -
sitemap.xml | 12 -
42 files changed, 8 insertions(+), 2549 deletions(-)
diff --git a/docs/5.0/cayenne-guide/additional-modules/index.html
b/docs/5.0/cayenne-guide/additional-modules/index.html
index 6fa2ff17d..4bedd89ae 100644
--- a/docs/5.0/cayenne-guide/additional-modules/index.html
+++ b/docs/5.0/cayenne-guide/additional-modules/index.html
@@ -252,12 +252,6 @@
-
-
-
-
-
-
@@ -282,8 +276,6 @@
-
-
diff --git a/docs/5.0/cayenne-guide/agentic-coding/index.html
b/docs/5.0/cayenne-guide/agentic-coding/index.html
index a26bfe229..945e0130e 100644
--- a/docs/5.0/cayenne-guide/agentic-coding/index.html
+++ b/docs/5.0/cayenne-guide/agentic-coding/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/ant_tasks/index.html
b/docs/5.0/cayenne-guide/ant_tasks/index.html
index a96eac699..2e1bf6aec 100644
--- a/docs/5.0/cayenne-guide/ant_tasks/index.html
+++ b/docs/5.0/cayenne-guide/ant_tasks/index.html
@@ -263,14 +263,6 @@
-
-
-
-
-
-
-
-
diff --git
a/docs/5.0/cayenne-guide/apache-cayenne-claude-code-plugin/index.html
b/docs/5.0/cayenne-guide/apache-cayenne-claude-code-plugin/index.html
index ecec3a3cd..8b70ba6e5 100644
--- a/docs/5.0/cayenne-guide/apache-cayenne-claude-code-plugin/index.html
+++ b/docs/5.0/cayenne-guide/apache-cayenne-claude-code-plugin/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
@@ -318,9 +310,9 @@
</div>
<div class="col-18 col-md-9 text-center
text-md-right">
- <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/installing-apache-cayenne-plugin-claude-code/'>
+ <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/cayenne-mcp-server/'>
<span class="d-block d-md-none
text-muted">Next: </span>
- Next: Cayenne Guide 5.0 · Installing
apache-cayenne Plugin (Claude Code)
+ Next: Cayenne Guide 5.0 · Cayenne MCP
Server
<i class="small fa fa-chevron-right
ml-3l2 d-none d-md-inline"></i>
</a>
diff --git
a/docs/5.0/cayenne-guide/appendix-a-configuration-properties/index.html
b/docs/5.0/cayenne-guide/appendix-a-configuration-properties/index.html
index 39ce96d1f..027793633 100644
--- a/docs/5.0/cayenne-guide/appendix-a-configuration-properties/index.html
+++ b/docs/5.0/cayenne-guide/appendix-a-configuration-properties/index.html
@@ -265,14 +265,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/appendix-b-service-collections/index.html
b/docs/5.0/cayenne-guide/appendix-b-service-collections/index.html
index 2039a6b75..a68c4438b 100644
--- a/docs/5.0/cayenne-guide/appendix-b-service-collections/index.html
+++ b/docs/5.0/cayenne-guide/appendix-b-service-collections/index.html
@@ -267,14 +267,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/build_tools/index.html
b/docs/5.0/cayenne-guide/build_tools/index.html
index 39e32c706..55be25cb3 100644
--- a/docs/5.0/cayenne-guide/build_tools/index.html
+++ b/docs/5.0/cayenne-guide/build_tools/index.html
@@ -261,14 +261,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/cayenne-framework/index.html
b/docs/5.0/cayenne-guide/cayenne-framework/index.html
index 677ae3852..fbd8229e7 100644
--- a/docs/5.0/cayenne-guide/cayenne-framework/index.html
+++ b/docs/5.0/cayenne-guide/cayenne-framework/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/cayenne-mapping-structure/index.html
b/docs/5.0/cayenne-guide/cayenne-mapping-structure/index.html
index e22616194..27c238347 100644
--- a/docs/5.0/cayenne-guide/cayenne-mapping-structure/index.html
+++ b/docs/5.0/cayenne-guide/cayenne-mapping-structure/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/cayenne-mcp-server/index.html
b/docs/5.0/cayenne-guide/cayenne-mcp-server/index.html
index d9a88d3ff..59c940adf 100644
--- a/docs/5.0/cayenne-guide/cayenne-mcp-server/index.html
+++ b/docs/5.0/cayenne-guide/cayenne-mcp-server/index.html
@@ -240,8 +240,6 @@
-
-
@@ -274,12 +272,6 @@
-
-
-
-
-
-
@@ -569,9 +561,9 @@ args = ["-jar",
"/path/to/CayenneMCPServer.jar"]</code></pre>
</div>
<div class="col-18 col-md-9 text-center
text-md-right">
- <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server/'>
+ <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/db-first-flow/'>
<span class="d-block d-md-none
text-muted">Next: </span>
- Next: Cayenne Guide 5.0 · Installing the
Cayenne MCP Server
+ Next: Cayenne Guide 5.0 · DB-First Flow
<i class="small fa fa-chevron-right
ml-3l2 d-none d-md-inline"></i>
</a>
diff --git a/docs/5.0/cayenne-guide/cayenne-modeler/index.html
b/docs/5.0/cayenne-guide/cayenne-modeler/index.html
index c7b41772f..fc1c656df 100644
--- a/docs/5.0/cayenne-guide/cayenne-modeler/index.html
+++ b/docs/5.0/cayenne-guide/cayenne-modeler/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/commit-log/index.html
b/docs/5.0/cayenne-guide/commit-log/index.html
index 4a9ff3f7b..406de1b61 100644
--- a/docs/5.0/cayenne-guide/commit-log/index.html
+++ b/docs/5.0/cayenne-guide/commit-log/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/customizing-cayenne-runtime/index.html
b/docs/5.0/cayenne-guide/customizing-cayenne-runtime/index.html
index e8a01a630..7277f2b36 100644
--- a/docs/5.0/cayenne-guide/customizing-cayenne-runtime/index.html
+++ b/docs/5.0/cayenne-guide/customizing-cayenne-runtime/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/db-first-flow/index.html
b/docs/5.0/cayenne-guide/db-first-flow/index.html
index e9f2d6eea..6da1bb5e1 100644
--- a/docs/5.0/cayenne-guide/db-first-flow/index.html
+++ b/docs/5.0/cayenne-guide/db-first-flow/index.html
@@ -242,10 +242,6 @@
-
-
-
-
@@ -278,10 +274,6 @@
-
-
-
-
@@ -310,9 +302,9 @@
</div>
<div class="col-18 col-md-9 text-center
text-md-right">
- <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/mcp-tools/'>
+ <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/re-introduction/'>
<span class="d-block d-md-none
text-muted">Next: </span>
- Next: Cayenne Guide 5.0 · MCP Tools
+ Next: Cayenne Guide 5.0 · Introduction
<i class="small fa fa-chevron-right
ml-3l2 d-none d-md-inline"></i>
</a>
diff --git a/docs/5.0/cayenne-guide/expressions/index.html
b/docs/5.0/cayenne-guide/expressions/index.html
index 7a9ebaa9c..88fe8a709 100644
--- a/docs/5.0/cayenne-guide/expressions/index.html
+++ b/docs/5.0/cayenne-guide/expressions/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/ext-cache-invalidation/index.html
b/docs/5.0/cayenne-guide/ext-cache-invalidation/index.html
index 40ead4df8..2f4457561 100644
--- a/docs/5.0/cayenne-guide/ext-cache-invalidation/index.html
+++ b/docs/5.0/cayenne-guide/ext-cache-invalidation/index.html
@@ -254,12 +254,6 @@
-
-
-
-
-
-
@@ -282,8 +276,6 @@
-
-
@@ -393,9 +385,9 @@ public class MyEntity extends _MyEntity {
</div>
<div class="col-18 col-md-9 text-center
text-md-right">
- <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/ext-commit-log/'>
+ <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/ext-crypto/'>
<span class="d-block d-md-none
text-muted">Next: </span>
- Next: Cayenne Guide 5.0 · Commit log
extension
+ Next: Cayenne Guide 5.0 · Crypto extension
<i class="small fa fa-chevron-right
ml-3l2 d-none d-md-inline"></i>
</a>
diff --git a/docs/5.0/cayenne-guide/ext-commit-log/index.html
b/docs/5.0/cayenne-guide/ext-commit-log/index.html
deleted file mode 100644
index c0e228370..000000000
--- a/docs/5.0/cayenne-guide/ext-commit-log/index.html
+++ /dev/null
@@ -1,549 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1,
maximum-scale=1.3">
- <link rel="apple-touch-icon" sizes="180x180"
href="/img/favicon/apple-touch-icon-04cb17e028.png">
- <link rel="icon" type="image/png" sizes="32x32"
href="/img/favicon/favicon-32x32-12431ee8eb.png">
- <link rel="icon" type="image/png" sizes="16x16"
href="/img/favicon/favicon-16x16-4f316e4d55.png">
- <link rel="manifest" href="/img/favicon/manifest-65e6aaa49e.json">
- <link rel="mask-icon"
href="/img/favicon/safari-pinned-tab-558c1991b1.svg" color="#dc5656">
- <link rel="shortcut icon" href="/img/favicon/favicon-6cef91375b.ico">
- <meta name="msapplication-TileColor" content="#ffffff">
- <meta name="msapplication-TileImage"
content="/img/favicon/mstile-144x144-34e7696278.png">
- <meta name="msapplication-config"
content="/img/favicon/browserconfig-82ff158058.xml">
- <meta name="theme-color" content="#ffffff">
- <link rel="stylesheet"
href="https://cayenne.apache.org/css/styles-9ee2e6e330.css"/>
- <script
src="https://cayenne.apache.org/js/bundle-c0e6356367.js";></script>
- <title>Cayenne Guide 5.0 · Commit log extension · Apache
Cayenne</title>
- </head>
- <body class="cd-head">
-<header class="page-header">
- <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation">
- <ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0">
- <li class="breadcrumb-item dropdown">
- <a class="dropdown-toggle text-nowrap pr-1" href="#"
id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true"
aria-expanded="false">
- <img class="mw-15px mr-1" src="/img/feather-641aa69d09.svg"
/>Apache Software Foundation</a>
- <div class="dropdown-menu rounded-0"
aria-labelledby="navbarDropdown">
- <a class="dropdown-item" href="https://www.apache.org";>Apache
Homepage</a>
- <a class="dropdown-item"
href="https://www.apache.org/licenses/";>License</a>
- <a class="dropdown-item"
href="https://www.apache.org/foundation/sponsorship.html";>Sponsorship</a>
- <a class="dropdown-item"
href="https://www.apache.org/foundation/thanks.html";>Thanks</a>
- <a class="dropdown-item"
href="https://www.apache.org/security/";>Security</a>
- <a class="dropdown-item"
href="https://privacy.apache.org/policies/privacy-policy-public.html";>Privacy</a>
- <a class="ml-1 mt-1 acevent" data-format="wide" data-mode="dark"
data-width="120"></a>
- </div>
- </li>
- </ul>
- </nav>
- <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
- <div class="container">
- <a class="navbar-brand" href="https://cayenne.apache.org/";>
- <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne"
/>
- </a>
- <button class="navbar-toggler" type="button" data-toggle="collapse"
data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false"
aria-label="Toggle navigation">
- <span class="navbar-toggler-icon"></span>
- </button>
-
- <div class="collapse navbar-collapse" id="mainMenu">
- <ul class="navbar-nav mt-3 mt-lg-0 mr-auto">
-
- <li class="nav-item">
- <a class="nav-link" href="/download/">DOWNLOAD</a>
- </li>
-
- <li class="nav-item">
- <a class="nav-link"
href="/docs/4.2/getting-started-guide/">DOCUMENTATION</a>
- </li>
-
- <li class="nav-item">
- <a class="nav-link" href="/about/support/">SUPPORT</a>
- </li>
-
- </ul>
- <ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0
mb-2 mb-lg-0 " id="social-links-menu">
- <li class="nav-item d-flex">
- <a class="nav-link d-flex justify-content-center
align-items-center" href="https://github.com/apache/cayenne";>
- <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub"
/>
- </a>
- </li>
- <li class="nav-item d-flex">
- <a class="nav-link d-flex justify-content-center
align-items-center" href="https://twitter.com/ApacheCayenne";>
- <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" />
- </a>
- </li>
- </ul>
- </div>
- </div>
- </nav>
-</header>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<main>
- <div class="cd-top-sidebar bb">
- <div class="container">
- <div class="row no-gutters">
-
- <div class="col-12 col-lg-4 col-xl-3 br cd-sidebar1">
- <ul class="nav" role="tablist">
- <li class="nav-item dropdown mw-100">
- <a class="nav-link dropdown-toggle text-truncate"
data-toggle="dropdown" href="#" role="button" aria-haspopup="true"
aria-expanded="false">
- Cayenne Version 5.0
- </a>
- <div class="dropdown-menu">
- <a class="dropdown-item"
href="/docs/5.0/getting-started-db-first/">Version 5.0 (Alpha)</a><a
class="dropdown-item" href="/docs/4.2/getting-started-guide/">Version 4.2
(Stable)</a><a class="dropdown-item"
href="/docs/4.1/getting-started-guide/">Version 4.1 (Stable)</a><a
class="dropdown-item" href="/docs/4.0/getting-started-guide/">Version 4.0
(Aging)</a><a class="dropdown-item"
href="/docs/3.1/getting-started-guide/">Version 3.1 (Legacy)</a>
- </div>
- </li>
- </ul>
- </div>
- <div class="col-12 col-lg-8 col-xl-9"> </div>
- </div>
- </div>
- </div>
- <div class="container">
- <div class="row no-gutters ">
- <div class="col-12 col-lg-4 col-xl-3 br py-2 bg-gray-100
cd-sidebar">
- <div class="tab-content" id="cd-docs-nav">
-
- <div class="cd-toc-item">
-
- <a class="cd-toc-link"
href="/docs/5.0/getting-started-db-first/">Database First Tutorial</a>
-
- </div>
-
- <div class="cd-toc-item">
-
- <a class="cd-toc-link"
href="/docs/5.0/getting-started-guide/">Getting Started</a>
-
- </div>
-
- <div class="cd-toc-item">
-
- <span class="cd-toc-link active">Cayenne
Guide</span><div id="toc" class="toc toc-side">
- <div id="toctitle">
- Table of Contents
- </div>
- <ul class="sectlevel1 nav">
- <li><a href="/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne"
class="nav-link" id="object-relational-mapping-with-cayenne">1. Object
Relational Mapping with Cayenne</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/setup" class="nav-link"
id="setup">1.1. Setup</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-mapping-structure"
class="nav-link" id="cayenne-mapping-structure">1.2. Cayenne Mapping
Structure</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-modeler" class="nav-link"
id="cayenne-modeler">1.3. CayenneModeler Application</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-framework" class="nav-link"
id="cayenne-framework">2. Cayenne Framework</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/including-cayenne-in-project"
class="nav-link" id="including-cayenne-in-project">2.1. Including Cayenne in a
Project</a></li>
- <li><a href="/docs/5.0/cayenne-guide/starting-cayenne" class="nav-link"
id="starting-cayenne">2.2. Starting Cayenne</a></li>
- <li><a href="/docs/5.0/cayenne-guide/persistent-objects-objectcontext"
class="nav-link" id="persistent-objects-objectcontext">2.3. Persistent Objects
and ObjectContext</a></li>
- <li><a href="/docs/5.0/cayenne-guide/expressions" class="nav-link"
id="expressions">2.4. Expressions</a></li>
- <li><a href="/docs/5.0/cayenne-guide/orderings" class="nav-link"
id="orderings">2.5. Orderings</a></li>
- <li><a href="/docs/5.0/cayenne-guide/queries" class="nav-link"
id="queries">2.6. Queries</a></li>
- <li><a href="/docs/5.0/cayenne-guide/lifecycle-events" class="nav-link"
id="lifecycle-events">2.7. Lifecycle Events</a></li>
- <li><a href="/docs/5.0/cayenne-guide/commit-log" class="nav-link"
id="commit-log">2.8. Commit Log</a></li>
- <li><a href="/docs/5.0/cayenne-guide/performance-tuning" class="nav-link"
id="performance-tuning">2.9. Performance Tuning</a></li>
- <li><a href="/docs/5.0/cayenne-guide/customizing-cayenne-runtime"
class="nav-link" id="customizing-cayenne-runtime">2.10. Customizing Cayenne
Runtime</a></li>
- </ul></li>
- <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/apache-cayenne-claude-code-plugin"
class="nav-link" id="apache-cayenne-claude-code-plugin">3.2.
<code>apache-cayenne</code> Claude Code Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-mcp-server" class="nav-link"
id="cayenne-mcp-server">3.3. Cayenne MCP Server</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">
- <li><a href="/docs/5.0/cayenne-guide/re-introduction" class="nav-link"
id="re-introduction">4.1. Introduction</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-filtering" class="nav-link"
id="re-filtering">4.2. Filtering</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-relationships-loading-control"
class="nav-link" id="re-relationships-loading-control">4.3. Other
Settings</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-modeler" class="nav-link"
id="re-modeler">4.4. Reverse Engineering in Cayenne Modeler</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/additional-modules" class="nav-link"
id="additional-modules">5. Additional Modules</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/ext-cache-invalidation"
class="nav-link" id="ext-cache-invalidation">5.1. Cache Invalidation
Extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-crypto" class="nav-link"
id="ext-crypto">5.2. Crypto extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-jcache" class="nav-link"
id="ext-jcache">5.3. JCache integration</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-project-compatibility"
class="nav-link" id="ext-project-compatibility">5.4. Project compatibility
extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-velocity" class="nav-link"
id="ext-velocity">5.5. Apache Velocity Extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-osgi" class="nav-link"
id="ext-osgi">5.6. Cayenne OSGI extension</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/build_tools" class="nav-link"
id="build_tools">6. Build Tools</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/maven_plugin" class="nav-link"
id="maven_plugin">6.1. Maven Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/gradle_plugin" class="nav-link"
id="gradle_plugin">6.2. Gradle Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ant_tasks" class="nav-link"
id="ant_tasks">6.3. Ant Tasks</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/appendix-a-configuration-properties"
class="nav-link" id="appendix-a-configuration-properties">7. Appendix A.
Configuration Properties</a></li>
- <li><a href="/docs/5.0/cayenne-guide/appendix-b-service-collections"
class="nav-link" id="appendix-b-service-collections">8. Appendix B. Service
Collections</a></li>
- </ul>
-</div>
- </div>
-
- <div class="cd-toc-item">
-
-
- <a class="cd-toc-link"
href="/docs/5.0/api/">JavaDoc</a></div>
- </div>
- </div>
-
- <div class="col-12 col-lg-8 col-xl-9 py-3 pl-lg-5 cd-content">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <article>
- <header>
- </header>
- <section>
- <div class="sect2">
- <h3 id="ext-commit-log"><a class="anchor" href="#ext-commit-log"></a>5.2.
Commit log extension</h3>
- <div class="paragraph">
- <p>The goal of this module is to capture commit changes and present them to
interested parties in an easy-to-process format.</p>
- </div>
- <div class="sect3">
- <h4 id="maven-3"><a class="anchor" href="#maven-3"></a>5.2.1. Maven</h4>
- <div class="listingblock">
- <div class="content">
- <pre class="highlight"><code class="language-XML XML"
data-lang="XML"><dependency>
- <groupId>org.apache.cayenne</groupId>
- <artifactId>cayenne-commitlog</artifactId>
- <version>5.0</version>
-</dependency></code></pre>
- </div>
- </div>
- </div>
- <div class="sect3">
- <h4 id="gradle-3"><a class="anchor" href="#gradle-3"></a>5.2.2. Gradle</h4>
- <div class="listingblock">
- <div class="content">
- <pre class="highlight"><code class="language-Groovy Groovy"
data-lang="Groovy">compile
'org.apache.cayenne:cayenne-commitlog:5.0'</code></pre>
- </div>
- </div>
- </div>
- <div class="sect3">
- <h4 id="usage-2"><a class="anchor" href="#usage-2"></a>5.2.3. Usage</h4>
- <div class="paragraph">
- <p>In order to use <code>commitlog</code> module you need to perform three
steps:</p>
- </div>
- <div class="olist arabic">
- <ol class="arabic">
- <li>
- <p>Mark all entities which changes you are interested in with
<code>@org.apache.cayenne.commitlog.CommitLog</code> annotation</p>
- <div class="listingblock">
- <div class="content">
- <pre class="highlight"><code class="language-Java Java"
data-lang="Java">@CommitLog(ignoredProperties = {"somePrivatePropertyToSkip"})
-public class MyEntity extends _MyEntity {
- // ...
-}</code></pre>
- </div>
- </div></li>
- <li>
- <p>Implement <code>CommitLogListener</code> interface.</p>
- <div class="listingblock">
- <div class="content">
- <pre class="highlight"><code class="language-java java"
data-lang="java">public class MyCommitLogListener implements CommitLogListener {
- @Override
- public void onPostCommit(ObjectContext originatingContext, ChangeMap
changes) {
- // ChangeMap will contain all information about changes happened in
performed commit
- // this particular example will print IDs of all inserted objects
- changes.getUniqueChanges().stream()
- .filter(change -> change.getType() == ObjectChangeType.INSERT)
- .map(ObjectChange::getPostCommitId)
- .forEach(id -> System.out.println("Inserted new entity with id:
" + id));
- }
-}</code></pre>
- </div>
- </div></li>
- <li>
- <p>Register your listener implementation.</p>
- <div class="listingblock">
- <div class="content">
- <pre class="highlight"><code class="language-java java"
data-lang="java">CayenneRuntime.builder()
- .addModule(binder -> CommitLogModule.extend(binder)
- .addListener(MyCommitLogListener.class))</code></pre>
- </div>
- </div>
- <div class="admonitionblock note">
- <table>
- <tbody>
- <tr>
- <td class="icon"><i class="fa fa-info-circle fa-2x"
title="Note"></i></td>
- <td class="content">You can use several listeners, but they all will
get same changes.</td>
- </tr>
- </tbody>
- </table>
- </div></li>
- </ol>
- </div>
- </div>
-</div>
- </section>
- <footer>
- <div class="row">
- <div class="col-6 col-md-3 text-center
text-md-left">
-
- </div>
- <div class="col-18 col-md-9 text-center
text-md-right">
-
- <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/ext-crypto/'>
- <span class="d-block d-md-none
text-muted">Next: </span>
- Next: Cayenne Guide 5.0 · Crypto extension
- <i class="small fa fa-chevron-right
ml-3l2 d-none d-md-inline"></i>
- </a>
-
- </div>
- </div>
- </footer>
- </article>
-
-
-<img referrerpolicy="no-referrer-when-downgrade"
src="https://static.scarf.sh/a.png?x-pxid=5c836e39-be6b-4a21-a946-a97b5b69f172";
/>
- </div>
- </div>
- </div>
-</main>
-
-<footer class="bg-dark">
- <div class="footer-nav container text-center text-lg-left pb-3">
- <div class="row pt-5 pb-3">
-
- <div class="col-sm-6 col-lg-3">
- <h4>About</h4>
- <ul class="list-unstyled">
-
- <li>
- <a href="/why-cayenne.html">Why Cayenne?</a>
- </li>
-
- <li>
- <a href="/download/">Download</a>
- </li>
-
- <li>
- <a href="/success-stories.html">Success Stories</a>
- </li>
-
- <li>
- <a href="/about/support/">Support</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>Documentation</h4>
- <ul class="list-unstyled">
-
- <li>
- <a href="/docs/4.0/getting-started-guide/">Getting
Started (4.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/getting-started-guide/">Getting
Started (4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/getting-started-guide/">Getting
Started (4.2)</a>
- </li>
-
- <li>
- <a href="/docs/4.0/cayenne-guide/">Cayenne Guide
(4.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/cayenne-guide/">Cayenne Guide
(4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/cayenne-guide/">Cayenne Guide
(4.2)</a>
- </li>
-
- <li>
- <a href="/docs/5.0/cayenne-guide/">Cayenne Guide
(5.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/getting-started-db-first/">Database
First tutorial (4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/getting-started-db-first/">Database
First tutorial (4.2)</a>
- </li>
-
- <li>
- <a href="/legacy/legacy-docs/">Legacy Documentation</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>Collaboration</h4>
- <ul class="list-unstyled">
-
- <li>
- <a
href="https://issues.apache.org/jira/browse/CAY";>Bug/Feature Tracker</a>
- </li>
-
- <li>
- <a href="/mailing-lists.html">Mailing Lists</a>
- </li>
-
- <li>
- <a href="/dev/code-repository.html">Code Repository</a>
- </li>
-
- <li>
- <a href="/dev/">Developer Guide</a>
- </li>
-
- <li>
- <a href="/how-can-i-help.html">How can I help?</a>
- </li>
-
- <li>
- <a href="/contributors.html">Contributors</a>
- </li>
-
- <li>
- <a href="/thanks.html">Thanks</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>News</h4>
- <ul class="list-multiline-items list-unstyled mb-0">
-
- <li>
- <time datetime="2025-11-19 10:00:00 +0300
+0300" class="xsmall d-block">Nov 19, 2025</time>
- <a href="/2025/11/cayenne-423-released/">Cayenne 4.2.3
Released</a>
- </li>
-
- <li>
- <time datetime="2025-03-24 10:00:00 +0300
+0300" class="xsmall d-block">Mar 24, 2025</time>
- <a href="/2025/03/cayenne-422-released/">Cayenne 4.2.2
Released</a>
- </li>
-
- <li>
- <time datetime="2024-09-09 12:00:00 +0300
+0300" class="xsmall d-block">Sep 09, 2024</time>
- <a href="/2024/09/cayenne-50m1-released/">Cayenne 5.0
Milestone 1 Released</a>
- </li>
-
- </ul>
- <a class="btn-link text-uppercase xsmall"
href="https://cayenne.apache.org/news";>
- More news
- <i class="fa fa-lg fa-long-arrow-right"
aria-hidden="true"></i>
- </a>
- </div>
- </div>
- <hr class="mt-0 mb-3" />
- <p class="copy xsmall text-center mw-75 mx-auto mb-0">
- Copyright © 2001-2026 Apache Software Foundation. Apache Cayenne,
Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo
are trademarks of The Apache Software Foundation.
- <a
href="https://privacy.apache.org/policies/privacy-policy-public.html";>Privacy
policy</a>.
- <img class="d-block mx-auto mt-2"
src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" />
- </p>
- </div>
-</footer>
- </body>
-</html>
diff --git a/docs/5.0/cayenne-guide/ext-crypto/index.html
b/docs/5.0/cayenne-guide/ext-crypto/index.html
index d347e6e7a..f69939466 100644
--- a/docs/5.0/cayenne-guide/ext-crypto/index.html
+++ b/docs/5.0/cayenne-guide/ext-crypto/index.html
@@ -256,14 +256,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/ext-jcache/index.html
b/docs/5.0/cayenne-guide/ext-jcache/index.html
index bd0b93bfc..da3bda4a1 100644
--- a/docs/5.0/cayenne-guide/ext-jcache/index.html
+++ b/docs/5.0/cayenne-guide/ext-jcache/index.html
@@ -258,14 +258,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/ext-osgi/index.html
b/docs/5.0/cayenne-guide/ext-osgi/index.html
index a354cf562..43928beb0 100644
--- a/docs/5.0/cayenne-guide/ext-osgi/index.html
+++ b/docs/5.0/cayenne-guide/ext-osgi/index.html
@@ -261,14 +261,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/ext-project-compatibility/index.html
b/docs/5.0/cayenne-guide/ext-project-compatibility/index.html
index e49f61b8f..f780ad181 100644
--- a/docs/5.0/cayenne-guide/ext-project-compatibility/index.html
+++ b/docs/5.0/cayenne-guide/ext-project-compatibility/index.html
@@ -260,14 +260,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/ext-velocity/index.html
b/docs/5.0/cayenne-guide/ext-velocity/index.html
index 616ab4199..a5393c2d0 100644
--- a/docs/5.0/cayenne-guide/ext-velocity/index.html
+++ b/docs/5.0/cayenne-guide/ext-velocity/index.html
@@ -261,14 +261,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/gradle_plugin/index.html
b/docs/5.0/cayenne-guide/gradle_plugin/index.html
index d2bf4822d..771427c5e 100644
--- a/docs/5.0/cayenne-guide/gradle_plugin/index.html
+++ b/docs/5.0/cayenne-guide/gradle_plugin/index.html
@@ -261,14 +261,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/including-cayenne-in-project/index.html
b/docs/5.0/cayenne-guide/including-cayenne-in-project/index.html
index 141ffd63f..fd2abb0a2 100644
--- a/docs/5.0/cayenne-guide/including-cayenne-in-project/index.html
+++ b/docs/5.0/cayenne-guide/including-cayenne-in-project/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git
a/docs/5.0/cayenne-guide/installing-apache-cayenne-plugin-claude-code/index.html
b/docs/5.0/cayenne-guide/installing-apache-cayenne-plugin-claude-code/index.html
deleted file mode 100644
index 363e6174e..000000000
---
a/docs/5.0/cayenne-guide/installing-apache-cayenne-plugin-claude-code/index.html
+++ /dev/null
@@ -1,483 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1,
maximum-scale=1.3">
- <link rel="apple-touch-icon" sizes="180x180"
href="/img/favicon/apple-touch-icon-04cb17e028.png">
- <link rel="icon" type="image/png" sizes="32x32"
href="/img/favicon/favicon-32x32-12431ee8eb.png">
- <link rel="icon" type="image/png" sizes="16x16"
href="/img/favicon/favicon-16x16-4f316e4d55.png">
- <link rel="manifest" href="/img/favicon/manifest-65e6aaa49e.json">
- <link rel="mask-icon"
href="/img/favicon/safari-pinned-tab-558c1991b1.svg" color="#dc5656">
- <link rel="shortcut icon" href="/img/favicon/favicon-6cef91375b.ico">
- <meta name="msapplication-TileColor" content="#ffffff">
- <meta name="msapplication-TileImage"
content="/img/favicon/mstile-144x144-34e7696278.png">
- <meta name="msapplication-config"
content="/img/favicon/browserconfig-82ff158058.xml">
- <meta name="theme-color" content="#ffffff">
- <link rel="stylesheet"
href="https://cayenne.apache.org/css/styles-9ee2e6e330.css"/>
- <script
src="https://cayenne.apache.org/js/bundle-c0e6356367.js";></script>
- <title>Cayenne Guide 5.0 · Installing apache-cayenne Plugin (Claude
Code) · Apache Cayenne</title>
- </head>
- <body class="cd-head">
-<header class="page-header">
- <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation">
- <ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0">
- <li class="breadcrumb-item dropdown">
- <a class="dropdown-toggle text-nowrap pr-1" href="#"
id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true"
aria-expanded="false">
- <img class="mw-15px mr-1" src="/img/feather-641aa69d09.svg"
/>Apache Software Foundation</a>
- <div class="dropdown-menu rounded-0"
aria-labelledby="navbarDropdown">
- <a class="dropdown-item" href="https://www.apache.org";>Apache
Homepage</a>
- <a class="dropdown-item"
href="https://www.apache.org/licenses/";>License</a>
- <a class="dropdown-item"
href="https://www.apache.org/foundation/sponsorship.html";>Sponsorship</a>
- <a class="dropdown-item"
href="https://www.apache.org/foundation/thanks.html";>Thanks</a>
- <a class="dropdown-item"
href="https://www.apache.org/security/";>Security</a>
- <a class="dropdown-item"
href="https://privacy.apache.org/policies/privacy-policy-public.html";>Privacy</a>
- <a class="ml-1 mt-1 acevent" data-format="wide" data-mode="dark"
data-width="120"></a>
- </div>
- </li>
- </ul>
- </nav>
- <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
- <div class="container">
- <a class="navbar-brand" href="https://cayenne.apache.org/";>
- <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne"
/>
- </a>
- <button class="navbar-toggler" type="button" data-toggle="collapse"
data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false"
aria-label="Toggle navigation">
- <span class="navbar-toggler-icon"></span>
- </button>
-
- <div class="collapse navbar-collapse" id="mainMenu">
- <ul class="navbar-nav mt-3 mt-lg-0 mr-auto">
-
- <li class="nav-item">
- <a class="nav-link" href="/download/">DOWNLOAD</a>
- </li>
-
- <li class="nav-item">
- <a class="nav-link"
href="/docs/4.2/getting-started-guide/">DOCUMENTATION</a>
- </li>
-
- <li class="nav-item">
- <a class="nav-link" href="/about/support/">SUPPORT</a>
- </li>
-
- </ul>
- <ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0
mb-2 mb-lg-0 " id="social-links-menu">
- <li class="nav-item d-flex">
- <a class="nav-link d-flex justify-content-center
align-items-center" href="https://github.com/apache/cayenne";>
- <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub"
/>
- </a>
- </li>
- <li class="nav-item d-flex">
- <a class="nav-link d-flex justify-content-center
align-items-center" href="https://twitter.com/ApacheCayenne";>
- <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" />
- </a>
- </li>
- </ul>
- </div>
- </div>
- </nav>
-</header>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<main>
- <div class="cd-top-sidebar bb">
- <div class="container">
- <div class="row no-gutters">
-
- <div class="col-12 col-lg-4 col-xl-3 br cd-sidebar1">
- <ul class="nav" role="tablist">
- <li class="nav-item dropdown mw-100">
- <a class="nav-link dropdown-toggle text-truncate"
data-toggle="dropdown" href="#" role="button" aria-haspopup="true"
aria-expanded="false">
- Cayenne Version 5.0
- </a>
- <div class="dropdown-menu">
- <a class="dropdown-item"
href="/docs/5.0/getting-started-db-first/">Version 5.0 (Alpha)</a><a
class="dropdown-item" href="/docs/4.2/getting-started-guide/">Version 4.2
(Stable)</a><a class="dropdown-item"
href="/docs/4.1/getting-started-guide/">Version 4.1 (Stable)</a><a
class="dropdown-item" href="/docs/4.0/getting-started-guide/">Version 4.0
(Aging)</a><a class="dropdown-item"
href="/docs/3.1/getting-started-guide/">Version 3.1 (Legacy)</a>
- </div>
- </li>
- </ul>
- </div>
- <div class="col-12 col-lg-8 col-xl-9"> </div>
- </div>
- </div>
- </div>
- <div class="container">
- <div class="row no-gutters ">
- <div class="col-12 col-lg-4 col-xl-3 br py-2 bg-gray-100
cd-sidebar">
- <div class="tab-content" id="cd-docs-nav">
-
- <div class="cd-toc-item">
-
- <a class="cd-toc-link"
href="/docs/5.0/getting-started-db-first/">Database First Tutorial</a>
-
- </div>
-
- <div class="cd-toc-item">
-
- <a class="cd-toc-link"
href="/docs/5.0/getting-started-guide/">Getting Started</a>
-
- </div>
-
- <div class="cd-toc-item">
-
- <span class="cd-toc-link active">Cayenne
Guide</span><div id="toc" class="toc toc-side">
- <div id="toctitle">
- Table of Contents
- </div>
- <ul class="sectlevel1 nav">
- <li><a href="/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne"
class="nav-link" id="object-relational-mapping-with-cayenne">1. Object
Relational Mapping with Cayenne</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/setup" class="nav-link"
id="setup">1.1. Setup</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-mapping-structure"
class="nav-link" id="cayenne-mapping-structure">1.2. Cayenne Mapping
Structure</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-modeler" class="nav-link"
id="cayenne-modeler">1.3. CayenneModeler Application</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-framework" class="nav-link"
id="cayenne-framework">2. Cayenne Framework</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/including-cayenne-in-project"
class="nav-link" id="including-cayenne-in-project">2.1. Including Cayenne in a
Project</a></li>
- <li><a href="/docs/5.0/cayenne-guide/starting-cayenne" class="nav-link"
id="starting-cayenne">2.2. Starting Cayenne</a></li>
- <li><a href="/docs/5.0/cayenne-guide/persistent-objects-objectcontext"
class="nav-link" id="persistent-objects-objectcontext">2.3. Persistent Objects
and ObjectContext</a></li>
- <li><a href="/docs/5.0/cayenne-guide/expressions" class="nav-link"
id="expressions">2.4. Expressions</a></li>
- <li><a href="/docs/5.0/cayenne-guide/orderings" class="nav-link"
id="orderings">2.5. Orderings</a></li>
- <li><a href="/docs/5.0/cayenne-guide/queries" class="nav-link"
id="queries">2.6. Queries</a></li>
- <li><a href="/docs/5.0/cayenne-guide/lifecycle-events" class="nav-link"
id="lifecycle-events">2.7. Lifecycle Events</a></li>
- <li><a href="/docs/5.0/cayenne-guide/commit-log" class="nav-link"
id="commit-log">2.8. Commit Log</a></li>
- <li><a href="/docs/5.0/cayenne-guide/performance-tuning" class="nav-link"
id="performance-tuning">2.9. Performance Tuning</a></li>
- <li><a href="/docs/5.0/cayenne-guide/customizing-cayenne-runtime"
class="nav-link" id="customizing-cayenne-runtime">2.10. Customizing Cayenne
Runtime</a></li>
- </ul></li>
- <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/apache-cayenne-claude-code-plugin"
class="nav-link" id="apache-cayenne-claude-code-plugin">3.2.
<code>apache-cayenne</code> Claude Code Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-mcp-server" class="nav-link"
id="cayenne-mcp-server">3.3. Cayenne MCP Server</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">
- <li><a href="/docs/5.0/cayenne-guide/re-introduction" class="nav-link"
id="re-introduction">4.1. Introduction</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-filtering" class="nav-link"
id="re-filtering">4.2. Filtering</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-relationships-loading-control"
class="nav-link" id="re-relationships-loading-control">4.3. Other
Settings</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-modeler" class="nav-link"
id="re-modeler">4.4. Reverse Engineering in Cayenne Modeler</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/additional-modules" class="nav-link"
id="additional-modules">5. Additional Modules</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/ext-cache-invalidation"
class="nav-link" id="ext-cache-invalidation">5.1. Cache Invalidation
Extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-crypto" class="nav-link"
id="ext-crypto">5.2. Crypto extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-jcache" class="nav-link"
id="ext-jcache">5.3. JCache integration</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-project-compatibility"
class="nav-link" id="ext-project-compatibility">5.4. Project compatibility
extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-velocity" class="nav-link"
id="ext-velocity">5.5. Apache Velocity Extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-osgi" class="nav-link"
id="ext-osgi">5.6. Cayenne OSGI extension</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/build_tools" class="nav-link"
id="build_tools">6. Build Tools</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/maven_plugin" class="nav-link"
id="maven_plugin">6.1. Maven Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/gradle_plugin" class="nav-link"
id="gradle_plugin">6.2. Gradle Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ant_tasks" class="nav-link"
id="ant_tasks">6.3. Ant Tasks</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/appendix-a-configuration-properties"
class="nav-link" id="appendix-a-configuration-properties">7. Appendix A.
Configuration Properties</a></li>
- <li><a href="/docs/5.0/cayenne-guide/appendix-b-service-collections"
class="nav-link" id="appendix-b-service-collections">8. Appendix B. Service
Collections</a></li>
- </ul>
-</div>
- </div>
-
- <div class="cd-toc-item">
-
-
- <a class="cd-toc-link"
href="/docs/5.0/api/">JavaDoc</a></div>
- </div>
- </div>
-
- <div class="col-12 col-lg-8 col-xl-9 py-3 pl-lg-5 cd-content">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <article>
- <header>
- </header>
- <section>
- <div class="sect2">
- <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>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 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>
- </section>
- <footer>
- <div class="row">
- <div class="col-6 col-md-3 text-center
text-md-left">
-
- </div>
- <div class="col-18 col-md-9 text-center
text-md-right">
-
- <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/cayenne-mcp-server/'>
- <span class="d-block d-md-none
text-muted">Next: </span>
- Next: Cayenne Guide 5.0 · Cayenne MCP
Server
- <i class="small fa fa-chevron-right
ml-3l2 d-none d-md-inline"></i>
- </a>
-
- </div>
- </div>
- </footer>
- </article>
-
-
-<img referrerpolicy="no-referrer-when-downgrade"
src="https://static.scarf.sh/a.png?x-pxid=5c836e39-be6b-4a21-a946-a97b5b69f172";
/>
- </div>
- </div>
- </div>
-</main>
-
-<footer class="bg-dark">
- <div class="footer-nav container text-center text-lg-left pb-3">
- <div class="row pt-5 pb-3">
-
- <div class="col-sm-6 col-lg-3">
- <h4>About</h4>
- <ul class="list-unstyled">
-
- <li>
- <a href="/why-cayenne.html">Why Cayenne?</a>
- </li>
-
- <li>
- <a href="/download/">Download</a>
- </li>
-
- <li>
- <a href="/success-stories.html">Success Stories</a>
- </li>
-
- <li>
- <a href="/about/support/">Support</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>Documentation</h4>
- <ul class="list-unstyled">
-
- <li>
- <a href="/docs/4.0/getting-started-guide/">Getting
Started (4.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/getting-started-guide/">Getting
Started (4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/getting-started-guide/">Getting
Started (4.2)</a>
- </li>
-
- <li>
- <a href="/docs/4.0/cayenne-guide/">Cayenne Guide
(4.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/cayenne-guide/">Cayenne Guide
(4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/cayenne-guide/">Cayenne Guide
(4.2)</a>
- </li>
-
- <li>
- <a href="/docs/5.0/cayenne-guide/">Cayenne Guide
(5.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/getting-started-db-first/">Database
First tutorial (4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/getting-started-db-first/">Database
First tutorial (4.2)</a>
- </li>
-
- <li>
- <a href="/legacy/legacy-docs/">Legacy Documentation</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>Collaboration</h4>
- <ul class="list-unstyled">
-
- <li>
- <a
href="https://issues.apache.org/jira/browse/CAY";>Bug/Feature Tracker</a>
- </li>
-
- <li>
- <a href="/mailing-lists.html">Mailing Lists</a>
- </li>
-
- <li>
- <a href="/dev/code-repository.html">Code Repository</a>
- </li>
-
- <li>
- <a href="/dev/">Developer Guide</a>
- </li>
-
- <li>
- <a href="/how-can-i-help.html">How can I help?</a>
- </li>
-
- <li>
- <a href="/contributors.html">Contributors</a>
- </li>
-
- <li>
- <a href="/thanks.html">Thanks</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>News</h4>
- <ul class="list-multiline-items list-unstyled mb-0">
-
- <li>
- <time datetime="2025-11-19 10:00:00 +0300
+0300" class="xsmall d-block">Nov 19, 2025</time>
- <a href="/2025/11/cayenne-423-released/">Cayenne 4.2.3
Released</a>
- </li>
-
- <li>
- <time datetime="2025-03-24 10:00:00 +0300
+0300" class="xsmall d-block">Mar 24, 2025</time>
- <a href="/2025/03/cayenne-422-released/">Cayenne 4.2.2
Released</a>
- </li>
-
- <li>
- <time datetime="2024-09-09 12:00:00 +0300
+0300" class="xsmall d-block">Sep 09, 2024</time>
- <a href="/2024/09/cayenne-50m1-released/">Cayenne 5.0
Milestone 1 Released</a>
- </li>
-
- </ul>
- <a class="btn-link text-uppercase xsmall"
href="https://cayenne.apache.org/news";>
- More news
- <i class="fa fa-lg fa-long-arrow-right"
aria-hidden="true"></i>
- </a>
- </div>
- </div>
- <hr class="mt-0 mb-3" />
- <p class="copy xsmall text-center mw-75 mx-auto mb-0">
- Copyright © 2001-2026 Apache Software Foundation. Apache Cayenne,
Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo
are trademarks of The Apache Software Foundation.
- <a
href="https://privacy.apache.org/policies/privacy-policy-public.html";>Privacy
policy</a>.
- <img class="d-block mx-auto mt-2"
src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" />
- </p>
- </div>
-</footer>
- </body>
-</html>
diff --git
a/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server/index.html
b/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server/index.html
deleted file mode 100644
index 403a80b36..000000000
--- a/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server/index.html
+++ /dev/null
@@ -1,547 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1,
maximum-scale=1.3">
- <link rel="apple-touch-icon" sizes="180x180"
href="/img/favicon/apple-touch-icon-04cb17e028.png">
- <link rel="icon" type="image/png" sizes="32x32"
href="/img/favicon/favicon-32x32-12431ee8eb.png">
- <link rel="icon" type="image/png" sizes="16x16"
href="/img/favicon/favicon-16x16-4f316e4d55.png">
- <link rel="manifest" href="/img/favicon/manifest-65e6aaa49e.json">
- <link rel="mask-icon"
href="/img/favicon/safari-pinned-tab-558c1991b1.svg" color="#dc5656">
- <link rel="shortcut icon" href="/img/favicon/favicon-6cef91375b.ico">
- <meta name="msapplication-TileColor" content="#ffffff">
- <meta name="msapplication-TileImage"
content="/img/favicon/mstile-144x144-34e7696278.png">
- <meta name="msapplication-config"
content="/img/favicon/browserconfig-82ff158058.xml">
- <meta name="theme-color" content="#ffffff">
- <link rel="stylesheet"
href="https://cayenne.apache.org/css/styles-9ee2e6e330.css"/>
- <script
src="https://cayenne.apache.org/js/bundle-c0e6356367.js";></script>
- <title>Cayenne Guide 5.0 · Installing the Cayenne MCP Server ·
Apache Cayenne</title>
- </head>
- <body class="cd-head">
-<header class="page-header">
- <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation">
- <ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0">
- <li class="breadcrumb-item dropdown">
- <a class="dropdown-toggle text-nowrap pr-1" href="#"
id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true"
aria-expanded="false">
- <img class="mw-15px mr-1" src="/img/feather-641aa69d09.svg"
/>Apache Software Foundation</a>
- <div class="dropdown-menu rounded-0"
aria-labelledby="navbarDropdown">
- <a class="dropdown-item" href="https://www.apache.org";>Apache
Homepage</a>
- <a class="dropdown-item"
href="https://www.apache.org/licenses/";>License</a>
- <a class="dropdown-item"
href="https://www.apache.org/foundation/sponsorship.html";>Sponsorship</a>
- <a class="dropdown-item"
href="https://www.apache.org/foundation/thanks.html";>Thanks</a>
- <a class="dropdown-item"
href="https://www.apache.org/security/";>Security</a>
- <a class="dropdown-item"
href="https://privacy.apache.org/policies/privacy-policy-public.html";>Privacy</a>
- <a class="ml-1 mt-1 acevent" data-format="wide" data-mode="dark"
data-width="120"></a>
- </div>
- </li>
- </ul>
- </nav>
- <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
- <div class="container">
- <a class="navbar-brand" href="https://cayenne.apache.org/";>
- <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne"
/>
- </a>
- <button class="navbar-toggler" type="button" data-toggle="collapse"
data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false"
aria-label="Toggle navigation">
- <span class="navbar-toggler-icon"></span>
- </button>
-
- <div class="collapse navbar-collapse" id="mainMenu">
- <ul class="navbar-nav mt-3 mt-lg-0 mr-auto">
-
- <li class="nav-item">
- <a class="nav-link" href="/download/">DOWNLOAD</a>
- </li>
-
- <li class="nav-item">
- <a class="nav-link"
href="/docs/4.2/getting-started-guide/">DOCUMENTATION</a>
- </li>
-
- <li class="nav-item">
- <a class="nav-link" href="/about/support/">SUPPORT</a>
- </li>
-
- </ul>
- <ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0
mb-2 mb-lg-0 " id="social-links-menu">
- <li class="nav-item d-flex">
- <a class="nav-link d-flex justify-content-center
align-items-center" href="https://github.com/apache/cayenne";>
- <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub"
/>
- </a>
- </li>
- <li class="nav-item d-flex">
- <a class="nav-link d-flex justify-content-center
align-items-center" href="https://twitter.com/ApacheCayenne";>
- <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" />
- </a>
- </li>
- </ul>
- </div>
- </div>
- </nav>
-</header>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<main>
- <div class="cd-top-sidebar bb">
- <div class="container">
- <div class="row no-gutters">
-
- <div class="col-12 col-lg-4 col-xl-3 br cd-sidebar1">
- <ul class="nav" role="tablist">
- <li class="nav-item dropdown mw-100">
- <a class="nav-link dropdown-toggle text-truncate"
data-toggle="dropdown" href="#" role="button" aria-haspopup="true"
aria-expanded="false">
- Cayenne Version 5.0
- </a>
- <div class="dropdown-menu">
- <a class="dropdown-item"
href="/docs/5.0/getting-started-db-first/">Version 5.0 (Alpha)</a><a
class="dropdown-item" href="/docs/4.2/getting-started-guide/">Version 4.2
(Stable)</a><a class="dropdown-item"
href="/docs/4.1/getting-started-guide/">Version 4.1 (Stable)</a><a
class="dropdown-item" href="/docs/4.0/getting-started-guide/">Version 4.0
(Aging)</a><a class="dropdown-item"
href="/docs/3.1/getting-started-guide/">Version 3.1 (Legacy)</a>
- </div>
- </li>
- </ul>
- </div>
- <div class="col-12 col-lg-8 col-xl-9"> </div>
- </div>
- </div>
- </div>
- <div class="container">
- <div class="row no-gutters ">
- <div class="col-12 col-lg-4 col-xl-3 br py-2 bg-gray-100
cd-sidebar">
- <div class="tab-content" id="cd-docs-nav">
-
- <div class="cd-toc-item">
-
- <a class="cd-toc-link"
href="/docs/5.0/getting-started-db-first/">Database First Tutorial</a>
-
- </div>
-
- <div class="cd-toc-item">
-
- <a class="cd-toc-link"
href="/docs/5.0/getting-started-guide/">Getting Started</a>
-
- </div>
-
- <div class="cd-toc-item">
-
- <span class="cd-toc-link active">Cayenne
Guide</span><div id="toc" class="toc toc-side">
- <div id="toctitle">
- Table of Contents
- </div>
- <ul class="sectlevel1 nav">
- <li><a href="/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne"
class="nav-link" id="object-relational-mapping-with-cayenne">1. Object
Relational Mapping with Cayenne</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/setup" class="nav-link"
id="setup">1.1. Setup</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-mapping-structure"
class="nav-link" id="cayenne-mapping-structure">1.2. Cayenne Mapping
Structure</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-modeler" class="nav-link"
id="cayenne-modeler">1.3. CayenneModeler Application</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-framework" class="nav-link"
id="cayenne-framework">2. Cayenne Framework</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/including-cayenne-in-project"
class="nav-link" id="including-cayenne-in-project">2.1. Including Cayenne in a
Project</a></li>
- <li><a href="/docs/5.0/cayenne-guide/starting-cayenne" class="nav-link"
id="starting-cayenne">2.2. Starting Cayenne</a></li>
- <li><a href="/docs/5.0/cayenne-guide/persistent-objects-objectcontext"
class="nav-link" id="persistent-objects-objectcontext">2.3. Persistent Objects
and ObjectContext</a></li>
- <li><a href="/docs/5.0/cayenne-guide/expressions" class="nav-link"
id="expressions">2.4. Expressions</a></li>
- <li><a href="/docs/5.0/cayenne-guide/orderings" class="nav-link"
id="orderings">2.5. Orderings</a></li>
- <li><a href="/docs/5.0/cayenne-guide/queries" class="nav-link"
id="queries">2.6. Queries</a></li>
- <li><a href="/docs/5.0/cayenne-guide/lifecycle-events" class="nav-link"
id="lifecycle-events">2.7. Lifecycle Events</a></li>
- <li><a href="/docs/5.0/cayenne-guide/commit-log" class="nav-link"
id="commit-log">2.8. Commit Log</a></li>
- <li><a href="/docs/5.0/cayenne-guide/performance-tuning" class="nav-link"
id="performance-tuning">2.9. Performance Tuning</a></li>
- <li><a href="/docs/5.0/cayenne-guide/customizing-cayenne-runtime"
class="nav-link" id="customizing-cayenne-runtime">2.10. Customizing Cayenne
Runtime</a></li>
- </ul></li>
- <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/apache-cayenne-claude-code-plugin"
class="nav-link" id="apache-cayenne-claude-code-plugin">3.2.
<code>apache-cayenne</code> Claude Code Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-mcp-server" class="nav-link"
id="cayenne-mcp-server">3.3. Cayenne MCP Server</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">
- <li><a href="/docs/5.0/cayenne-guide/re-introduction" class="nav-link"
id="re-introduction">4.1. Introduction</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-filtering" class="nav-link"
id="re-filtering">4.2. Filtering</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-relationships-loading-control"
class="nav-link" id="re-relationships-loading-control">4.3. Other
Settings</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-modeler" class="nav-link"
id="re-modeler">4.4. Reverse Engineering in Cayenne Modeler</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/additional-modules" class="nav-link"
id="additional-modules">5. Additional Modules</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/ext-cache-invalidation"
class="nav-link" id="ext-cache-invalidation">5.1. Cache Invalidation
Extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-crypto" class="nav-link"
id="ext-crypto">5.2. Crypto extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-jcache" class="nav-link"
id="ext-jcache">5.3. JCache integration</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-project-compatibility"
class="nav-link" id="ext-project-compatibility">5.4. Project compatibility
extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-velocity" class="nav-link"
id="ext-velocity">5.5. Apache Velocity Extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-osgi" class="nav-link"
id="ext-osgi">5.6. Cayenne OSGI extension</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/build_tools" class="nav-link"
id="build_tools">6. Build Tools</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/maven_plugin" class="nav-link"
id="maven_plugin">6.1. Maven Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/gradle_plugin" class="nav-link"
id="gradle_plugin">6.2. Gradle Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ant_tasks" class="nav-link"
id="ant_tasks">6.3. Ant Tasks</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/appendix-a-configuration-properties"
class="nav-link" id="appendix-a-configuration-properties">7. Appendix A.
Configuration Properties</a></li>
- <li><a href="/docs/5.0/cayenne-guide/appendix-b-service-collections"
class="nav-link" id="appendix-b-service-collections">8. Appendix B. Service
Collections</a></li>
- </ul>
-</div>
- </div>
-
- <div class="cd-toc-item">
-
-
- <a class="cd-toc-link"
href="/docs/5.0/api/">JavaDoc</a></div>
- </div>
- </div>
-
- <div class="col-12 col-lg-8 col-xl-9 py-3 pl-lg-5 cd-content">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <article>
- <header>
- </header>
- <section>
- <div class="sect2">
- <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 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="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>
- <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>
- <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>
- <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="cursor"><a class="anchor" href="#cursor"></a>3.3.2. Cursor</h4>
- <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">{
- "mcpServers": {
- "cayenne": {
- "command": "java",
- "args": ["-jar", "/path/to/CayenneMCPServer.jar"]
- }
- }
-}</code></pre>
- </div>
- </div>
- </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/CayenneMCPServer.jar"]</code></pre>
- </div>
- </div>
- </div>
-</div>
- </section>
- <footer>
- <div class="row">
- <div class="col-6 col-md-3 text-center
text-md-left">
-
- </div>
- <div class="col-18 col-md-9 text-center
text-md-right">
-
- <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/db-first-flow/'>
- <span class="d-block d-md-none
text-muted">Next: </span>
- Next: Cayenne Guide 5.0 · DB-First Flow
- <i class="small fa fa-chevron-right
ml-3l2 d-none d-md-inline"></i>
- </a>
-
- </div>
- </div>
- </footer>
- </article>
-
-
-<img referrerpolicy="no-referrer-when-downgrade"
src="https://static.scarf.sh/a.png?x-pxid=5c836e39-be6b-4a21-a946-a97b5b69f172";
/>
- </div>
- </div>
- </div>
-</main>
-
-<footer class="bg-dark">
- <div class="footer-nav container text-center text-lg-left pb-3">
- <div class="row pt-5 pb-3">
-
- <div class="col-sm-6 col-lg-3">
- <h4>About</h4>
- <ul class="list-unstyled">
-
- <li>
- <a href="/why-cayenne.html">Why Cayenne?</a>
- </li>
-
- <li>
- <a href="/download/">Download</a>
- </li>
-
- <li>
- <a href="/success-stories.html">Success Stories</a>
- </li>
-
- <li>
- <a href="/about/support/">Support</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>Documentation</h4>
- <ul class="list-unstyled">
-
- <li>
- <a href="/docs/4.0/getting-started-guide/">Getting
Started (4.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/getting-started-guide/">Getting
Started (4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/getting-started-guide/">Getting
Started (4.2)</a>
- </li>
-
- <li>
- <a href="/docs/4.0/cayenne-guide/">Cayenne Guide
(4.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/cayenne-guide/">Cayenne Guide
(4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/cayenne-guide/">Cayenne Guide
(4.2)</a>
- </li>
-
- <li>
- <a href="/docs/5.0/cayenne-guide/">Cayenne Guide
(5.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/getting-started-db-first/">Database
First tutorial (4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/getting-started-db-first/">Database
First tutorial (4.2)</a>
- </li>
-
- <li>
- <a href="/legacy/legacy-docs/">Legacy Documentation</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>Collaboration</h4>
- <ul class="list-unstyled">
-
- <li>
- <a
href="https://issues.apache.org/jira/browse/CAY";>Bug/Feature Tracker</a>
- </li>
-
- <li>
- <a href="/mailing-lists.html">Mailing Lists</a>
- </li>
-
- <li>
- <a href="/dev/code-repository.html">Code Repository</a>
- </li>
-
- <li>
- <a href="/dev/">Developer Guide</a>
- </li>
-
- <li>
- <a href="/how-can-i-help.html">How can I help?</a>
- </li>
-
- <li>
- <a href="/contributors.html">Contributors</a>
- </li>
-
- <li>
- <a href="/thanks.html">Thanks</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>News</h4>
- <ul class="list-multiline-items list-unstyled mb-0">
-
- <li>
- <time datetime="2025-11-19 10:00:00 +0300
+0300" class="xsmall d-block">Nov 19, 2025</time>
- <a href="/2025/11/cayenne-423-released/">Cayenne 4.2.3
Released</a>
- </li>
-
- <li>
- <time datetime="2025-03-24 10:00:00 +0300
+0300" class="xsmall d-block">Mar 24, 2025</time>
- <a href="/2025/03/cayenne-422-released/">Cayenne 4.2.2
Released</a>
- </li>
-
- <li>
- <time datetime="2024-09-09 12:00:00 +0300
+0300" class="xsmall d-block">Sep 09, 2024</time>
- <a href="/2024/09/cayenne-50m1-released/">Cayenne 5.0
Milestone 1 Released</a>
- </li>
-
- </ul>
- <a class="btn-link text-uppercase xsmall"
href="https://cayenne.apache.org/news";>
- More news
- <i class="fa fa-lg fa-long-arrow-right"
aria-hidden="true"></i>
- </a>
- </div>
- </div>
- <hr class="mt-0 mb-3" />
- <p class="copy xsmall text-center mw-75 mx-auto mb-0">
- Copyright © 2001-2026 Apache Software Foundation. Apache Cayenne,
Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo
are trademarks of The Apache Software Foundation.
- <a
href="https://privacy.apache.org/policies/privacy-policy-public.html";>Privacy
policy</a>.
- <img class="d-block mx-auto mt-2"
src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" />
- </p>
- </div>
-</footer>
- </body>
-</html>
diff --git a/docs/5.0/cayenne-guide/lifecycle-events/index.html
b/docs/5.0/cayenne-guide/lifecycle-events/index.html
index 85dd2e12c..b7bc3b9ca 100644
--- a/docs/5.0/cayenne-guide/lifecycle-events/index.html
+++ b/docs/5.0/cayenne-guide/lifecycle-events/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/maven_plugin/index.html
b/docs/5.0/cayenne-guide/maven_plugin/index.html
index 03e5adf63..f188f4c6b 100644
--- a/docs/5.0/cayenne-guide/maven_plugin/index.html
+++ b/docs/5.0/cayenne-guide/maven_plugin/index.html
@@ -261,14 +261,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/mcp-tools/index.html
b/docs/5.0/cayenne-guide/mcp-tools/index.html
deleted file mode 100644
index a5dce2538..000000000
--- a/docs/5.0/cayenne-guide/mcp-tools/index.html
+++ /dev/null
@@ -1,654 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1,
maximum-scale=1.3">
- <link rel="apple-touch-icon" sizes="180x180"
href="/img/favicon/apple-touch-icon-04cb17e028.png">
- <link rel="icon" type="image/png" sizes="32x32"
href="/img/favicon/favicon-32x32-12431ee8eb.png">
- <link rel="icon" type="image/png" sizes="16x16"
href="/img/favicon/favicon-16x16-4f316e4d55.png">
- <link rel="manifest" href="/img/favicon/manifest-65e6aaa49e.json">
- <link rel="mask-icon"
href="/img/favicon/safari-pinned-tab-558c1991b1.svg" color="#dc5656">
- <link rel="shortcut icon" href="/img/favicon/favicon-6cef91375b.ico">
- <meta name="msapplication-TileColor" content="#ffffff">
- <meta name="msapplication-TileImage"
content="/img/favicon/mstile-144x144-34e7696278.png">
- <meta name="msapplication-config"
content="/img/favicon/browserconfig-82ff158058.xml">
- <meta name="theme-color" content="#ffffff">
- <link rel="stylesheet"
href="https://cayenne.apache.org/css/styles-9ee2e6e330.css"/>
- <script
src="https://cayenne.apache.org/js/bundle-c0e6356367.js";></script>
- <title>Cayenne Guide 5.0 · MCP Tools · Apache Cayenne</title>
- </head>
- <body class="cd-head">
-<header class="page-header">
- <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation">
- <ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0">
- <li class="breadcrumb-item dropdown">
- <a class="dropdown-toggle text-nowrap pr-1" href="#"
id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true"
aria-expanded="false">
- <img class="mw-15px mr-1" src="/img/feather-641aa69d09.svg"
/>Apache Software Foundation</a>
- <div class="dropdown-menu rounded-0"
aria-labelledby="navbarDropdown">
- <a class="dropdown-item" href="https://www.apache.org";>Apache
Homepage</a>
- <a class="dropdown-item"
href="https://www.apache.org/licenses/";>License</a>
- <a class="dropdown-item"
href="https://www.apache.org/foundation/sponsorship.html";>Sponsorship</a>
- <a class="dropdown-item"
href="https://www.apache.org/foundation/thanks.html";>Thanks</a>
- <a class="dropdown-item"
href="https://www.apache.org/security/";>Security</a>
- <a class="dropdown-item"
href="https://privacy.apache.org/policies/privacy-policy-public.html";>Privacy</a>
- <a class="ml-1 mt-1 acevent" data-format="wide" data-mode="dark"
data-width="120"></a>
- </div>
- </li>
- </ul>
- </nav>
- <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
- <div class="container">
- <a class="navbar-brand" href="https://cayenne.apache.org/";>
- <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne"
/>
- </a>
- <button class="navbar-toggler" type="button" data-toggle="collapse"
data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false"
aria-label="Toggle navigation">
- <span class="navbar-toggler-icon"></span>
- </button>
-
- <div class="collapse navbar-collapse" id="mainMenu">
- <ul class="navbar-nav mt-3 mt-lg-0 mr-auto">
-
- <li class="nav-item">
- <a class="nav-link" href="/download/">DOWNLOAD</a>
- </li>
-
- <li class="nav-item">
- <a class="nav-link"
href="/docs/4.2/getting-started-guide/">DOCUMENTATION</a>
- </li>
-
- <li class="nav-item">
- <a class="nav-link" href="/about/support/">SUPPORT</a>
- </li>
-
- </ul>
- <ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0
mb-2 mb-lg-0 " id="social-links-menu">
- <li class="nav-item d-flex">
- <a class="nav-link d-flex justify-content-center
align-items-center" href="https://github.com/apache/cayenne";>
- <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub"
/>
- </a>
- </li>
- <li class="nav-item d-flex">
- <a class="nav-link d-flex justify-content-center
align-items-center" href="https://twitter.com/ApacheCayenne";>
- <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" />
- </a>
- </li>
- </ul>
- </div>
- </div>
- </nav>
-</header>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<main>
- <div class="cd-top-sidebar bb">
- <div class="container">
- <div class="row no-gutters">
-
- <div class="col-12 col-lg-4 col-xl-3 br cd-sidebar1">
- <ul class="nav" role="tablist">
- <li class="nav-item dropdown mw-100">
- <a class="nav-link dropdown-toggle text-truncate"
data-toggle="dropdown" href="#" role="button" aria-haspopup="true"
aria-expanded="false">
- Cayenne Version 5.0
- </a>
- <div class="dropdown-menu">
- <a class="dropdown-item"
href="/docs/5.0/getting-started-db-first/">Version 5.0 (Alpha)</a><a
class="dropdown-item" href="/docs/4.2/getting-started-guide/">Version 4.2
(Stable)</a><a class="dropdown-item"
href="/docs/4.1/getting-started-guide/">Version 4.1 (Stable)</a><a
class="dropdown-item" href="/docs/4.0/getting-started-guide/">Version 4.0
(Aging)</a><a class="dropdown-item"
href="/docs/3.1/getting-started-guide/">Version 3.1 (Legacy)</a>
- </div>
- </li>
- </ul>
- </div>
- <div class="col-12 col-lg-8 col-xl-9"> </div>
- </div>
- </div>
- </div>
- <div class="container">
- <div class="row no-gutters ">
- <div class="col-12 col-lg-4 col-xl-3 br py-2 bg-gray-100
cd-sidebar">
- <div class="tab-content" id="cd-docs-nav">
-
- <div class="cd-toc-item">
-
- <a class="cd-toc-link"
href="/docs/5.0/getting-started-db-first/">Database First Tutorial</a>
-
- </div>
-
- <div class="cd-toc-item">
-
- <a class="cd-toc-link"
href="/docs/5.0/getting-started-guide/">Getting Started</a>
-
- </div>
-
- <div class="cd-toc-item">
-
- <span class="cd-toc-link active">Cayenne
Guide</span><div id="toc" class="toc toc-side">
- <div id="toctitle">
- Table of Contents
- </div>
- <ul class="sectlevel1 nav">
- <li><a href="/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne"
class="nav-link" id="object-relational-mapping-with-cayenne">1. Object
Relational Mapping with Cayenne</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/setup" class="nav-link"
id="setup">1.1. Setup</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-mapping-structure"
class="nav-link" id="cayenne-mapping-structure">1.2. Cayenne Mapping
Structure</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-modeler" class="nav-link"
id="cayenne-modeler">1.3. CayenneModeler Application</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-framework" class="nav-link"
id="cayenne-framework">2. Cayenne Framework</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/including-cayenne-in-project"
class="nav-link" id="including-cayenne-in-project">2.1. Including Cayenne in a
Project</a></li>
- <li><a href="/docs/5.0/cayenne-guide/starting-cayenne" class="nav-link"
id="starting-cayenne">2.2. Starting Cayenne</a></li>
- <li><a href="/docs/5.0/cayenne-guide/persistent-objects-objectcontext"
class="nav-link" id="persistent-objects-objectcontext">2.3. Persistent Objects
and ObjectContext</a></li>
- <li><a href="/docs/5.0/cayenne-guide/expressions" class="nav-link"
id="expressions">2.4. Expressions</a></li>
- <li><a href="/docs/5.0/cayenne-guide/orderings" class="nav-link"
id="orderings">2.5. Orderings</a></li>
- <li><a href="/docs/5.0/cayenne-guide/queries" class="nav-link"
id="queries">2.6. Queries</a></li>
- <li><a href="/docs/5.0/cayenne-guide/lifecycle-events" class="nav-link"
id="lifecycle-events">2.7. Lifecycle Events</a></li>
- <li><a href="/docs/5.0/cayenne-guide/commit-log" class="nav-link"
id="commit-log">2.8. Commit Log</a></li>
- <li><a href="/docs/5.0/cayenne-guide/performance-tuning" class="nav-link"
id="performance-tuning">2.9. Performance Tuning</a></li>
- <li><a href="/docs/5.0/cayenne-guide/customizing-cayenne-runtime"
class="nav-link" id="customizing-cayenne-runtime">2.10. Customizing Cayenne
Runtime</a></li>
- </ul></li>
- <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/apache-cayenne-claude-code-plugin"
class="nav-link" id="apache-cayenne-claude-code-plugin">3.2.
<code>apache-cayenne</code> Claude Code Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-mcp-server" class="nav-link"
id="cayenne-mcp-server">3.3. Cayenne MCP Server</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">
- <li><a href="/docs/5.0/cayenne-guide/re-introduction" class="nav-link"
id="re-introduction">4.1. Introduction</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-filtering" class="nav-link"
id="re-filtering">4.2. Filtering</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-relationships-loading-control"
class="nav-link" id="re-relationships-loading-control">4.3. Other
Settings</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-modeler" class="nav-link"
id="re-modeler">4.4. Reverse Engineering in Cayenne Modeler</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/additional-modules" class="nav-link"
id="additional-modules">5. Additional Modules</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/ext-cache-invalidation"
class="nav-link" id="ext-cache-invalidation">5.1. Cache Invalidation
Extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-crypto" class="nav-link"
id="ext-crypto">5.2. Crypto extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-jcache" class="nav-link"
id="ext-jcache">5.3. JCache integration</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-project-compatibility"
class="nav-link" id="ext-project-compatibility">5.4. Project compatibility
extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-velocity" class="nav-link"
id="ext-velocity">5.5. Apache Velocity Extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-osgi" class="nav-link"
id="ext-osgi">5.6. Cayenne OSGI extension</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/build_tools" class="nav-link"
id="build_tools">6. Build Tools</a>
- <ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/maven_plugin" class="nav-link"
id="maven_plugin">6.1. Maven Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/gradle_plugin" class="nav-link"
id="gradle_plugin">6.2. Gradle Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ant_tasks" class="nav-link"
id="ant_tasks">6.3. Ant Tasks</a></li>
- </ul></li>
- <li><a href="/docs/5.0/cayenne-guide/appendix-a-configuration-properties"
class="nav-link" id="appendix-a-configuration-properties">7. Appendix A.
Configuration Properties</a></li>
- <li><a href="/docs/5.0/cayenne-guide/appendix-b-service-collections"
class="nav-link" id="appendix-b-service-collections">8. Appendix B. Service
Collections</a></li>
- </ul>
-</div>
- </div>
-
- <div class="cd-toc-item">
-
-
- <a class="cd-toc-link"
href="/docs/5.0/api/">JavaDoc</a></div>
- </div>
- </div>
-
- <div class="col-12 col-lg-8 col-xl-9 py-3 pl-lg-5 cd-content">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <article>
- <header>
- </header>
- <section>
- <div class="sect2">
- <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>
- </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.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>
- <table class="tableblock frame-all grid-all stretch">
- <caption class="title">
- Table 4. Parameters
- </caption>
- <colgroup>
- <col style="width: 20%;">
- <col style="width: 20%;">
- <col style="width: 60%;">
- </colgroup>
- <thead>
- <tr>
- <th class="tableblock halign-left valign-top">Name</th>
- <th class="tableblock halign-left valign-top">Required</th>
- <th class="tableblock halign-left valign-top">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock"><code>projectPath</code></p></td>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock">yes</p></td>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock">Absolute path to the top-level Cayenne project
descriptor (<code>cayenne-*.xml</code>).</p></td>
- </tr>
- </tbody>
- </table>
- <div class="paragraph">
- <p>In most cases your agent knows where the project is, so a typical prompt
that triggers this tool is just this:</p>
- </div>
- <div class="quoteblock">
- <blockquote>
- <div class="paragraph">
- <p>open my Cayenne project in the Modeler</p>
- </div>
- </blockquote>
- </div>
- <div class="paragraph">
- <p>Though you can be more specific and indicate the exact project to
open:</p>
- </div>
- <div class="quoteblock">
- <blockquote>
- <div class="paragraph">
- <p>open the Cayenne project at @/path/to/cayenne-project.xml in the
Modeler.</p>
- </div>
- </blockquote>
- </div>
- </div>
- <div class="sect3">
- <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>
- <table class="tableblock frame-all grid-all stretch">
- <caption class="title">
- Table 5. Parameters
- </caption>
- <colgroup>
- <col style="width: 20%;">
- <col style="width: 20%;">
- <col style="width: 60%;">
- </colgroup>
- <thead>
- <tr>
- <th class="tableblock halign-left valign-top">Name</th>
- <th class="tableblock halign-left valign-top">Required</th>
- <th class="tableblock halign-left valign-top">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock"><code>projectPath</code></p></td>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock">yes</p></td>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock">Absolute path to the top-level Cayenne project
descriptor (<code>cayenne-*.xml</code>), not a DataMap file.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock"><code>dataMap</code></p></td>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock">yes</p></td>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock">Name of the target DataMap as it appears in the
<code><map name='…'></code> element of the project descriptor.</p></td>
- </tr>
- </tbody>
- </table>
- <div class="paragraph">
- <p>A typical agent prompt that triggers this tool:</p>
- </div>
- <div class="quoteblock">
- <blockquote>
- <div class="paragraph">
- <p>regenerate Java classes for the <code>MyDataMap</code> DataMap in
<code>/path/to/cayenne-project.xml</code>.</p>
- </div>
- </blockquote>
- </div>
- <div class="paragraph">
- <p>Or if you only have one project and one DataMap:</p>
- </div>
- <div class="quoteblock">
- <blockquote>
- <div class="paragraph">
- <p>regenerate Java classes from Cayenne model</p>
- </div>
- </blockquote>
- </div>
- </div>
- <div class="sect3">
- <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 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>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">
- Table 6. Parameters
- </caption>
- <colgroup>
- <col style="width: 20%;">
- <col style="width: 20%;">
- <col style="width: 60%;">
- </colgroup>
- <thead>
- <tr>
- <th class="tableblock halign-left valign-top">Name</th>
- <th class="tableblock halign-left valign-top">Required</th>
- <th class="tableblock halign-left valign-top">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock"><code>projectPath</code></p></td>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock">yes</p></td>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock">Absolute path to the top-level Cayenne project
descriptor (<code>cayenne-*.xml</code>), not a DataMap file.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock"><code>dataMap</code></p></td>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock">yes</p></td>
- <td class="tableblock halign-left valign-top">
- <p class="tableblock">Name of the target DataMap as it appears in the
<code><map name='…'></code> element of the project descriptor.</p></td>
- </tr>
- </tbody>
- </table>
- <div class="paragraph">
- <p>A typical agent prompt that triggers this tool:</p>
- </div>
- <div class="quoteblock">
- <blockquote>
- <div class="paragraph">
- <p>sync the Cayenne model with the database</p>
- </div>
- </blockquote>
- </div>
- <div class="paragraph">
- <p>Or more specifically:</p>
- </div>
- <div class="quoteblock">
- <blockquote>
- <div class="paragraph">
- <p>re-import the <code>MyDataMap</code> schema from the database into
<code>/path/to/cayenne-project.xml</code></p>
- </div>
- </blockquote>
- </div>
- </div>
-</div>
- </section>
- <footer>
- <div class="row">
- <div class="col-6 col-md-3 text-center
text-md-left">
-
- </div>
- <div class="col-18 col-md-9 text-center
text-md-right">
-
- <a class="btn btn-link"
href='/docs/5.0/cayenne-guide/re-introduction/'>
- <span class="d-block d-md-none
text-muted">Next: </span>
- Next: Cayenne Guide 5.0 · Introduction
- <i class="small fa fa-chevron-right
ml-3l2 d-none d-md-inline"></i>
- </a>
-
- </div>
- </div>
- </footer>
- </article>
-
-
-<img referrerpolicy="no-referrer-when-downgrade"
src="https://static.scarf.sh/a.png?x-pxid=5c836e39-be6b-4a21-a946-a97b5b69f172";
/>
- </div>
- </div>
- </div>
-</main>
-
-<footer class="bg-dark">
- <div class="footer-nav container text-center text-lg-left pb-3">
- <div class="row pt-5 pb-3">
-
- <div class="col-sm-6 col-lg-3">
- <h4>About</h4>
- <ul class="list-unstyled">
-
- <li>
- <a href="/why-cayenne.html">Why Cayenne?</a>
- </li>
-
- <li>
- <a href="/download/">Download</a>
- </li>
-
- <li>
- <a href="/success-stories.html">Success Stories</a>
- </li>
-
- <li>
- <a href="/about/support/">Support</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>Documentation</h4>
- <ul class="list-unstyled">
-
- <li>
- <a href="/docs/4.0/getting-started-guide/">Getting
Started (4.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/getting-started-guide/">Getting
Started (4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/getting-started-guide/">Getting
Started (4.2)</a>
- </li>
-
- <li>
- <a href="/docs/4.0/cayenne-guide/">Cayenne Guide
(4.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/cayenne-guide/">Cayenne Guide
(4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/cayenne-guide/">Cayenne Guide
(4.2)</a>
- </li>
-
- <li>
- <a href="/docs/5.0/cayenne-guide/">Cayenne Guide
(5.0)</a>
- </li>
-
- <li>
- <a href="/docs/4.1/getting-started-db-first/">Database
First tutorial (4.1)</a>
- </li>
-
- <li>
- <a href="/docs/4.2/getting-started-db-first/">Database
First tutorial (4.2)</a>
- </li>
-
- <li>
- <a href="/legacy/legacy-docs/">Legacy Documentation</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>Collaboration</h4>
- <ul class="list-unstyled">
-
- <li>
- <a
href="https://issues.apache.org/jira/browse/CAY";>Bug/Feature Tracker</a>
- </li>
-
- <li>
- <a href="/mailing-lists.html">Mailing Lists</a>
- </li>
-
- <li>
- <a href="/dev/code-repository.html">Code Repository</a>
- </li>
-
- <li>
- <a href="/dev/">Developer Guide</a>
- </li>
-
- <li>
- <a href="/how-can-i-help.html">How can I help?</a>
- </li>
-
- <li>
- <a href="/contributors.html">Contributors</a>
- </li>
-
- <li>
- <a href="/thanks.html">Thanks</a>
- </li>
-
- </ul>
- </div>
-
- <div class="col-sm-6 col-lg-3">
- <h4>News</h4>
- <ul class="list-multiline-items list-unstyled mb-0">
-
- <li>
- <time datetime="2025-11-19 10:00:00 +0300
+0300" class="xsmall d-block">Nov 19, 2025</time>
- <a href="/2025/11/cayenne-423-released/">Cayenne 4.2.3
Released</a>
- </li>
-
- <li>
- <time datetime="2025-03-24 10:00:00 +0300
+0300" class="xsmall d-block">Mar 24, 2025</time>
- <a href="/2025/03/cayenne-422-released/">Cayenne 4.2.2
Released</a>
- </li>
-
- <li>
- <time datetime="2024-09-09 12:00:00 +0300
+0300" class="xsmall d-block">Sep 09, 2024</time>
- <a href="/2024/09/cayenne-50m1-released/">Cayenne 5.0
Milestone 1 Released</a>
- </li>
-
- </ul>
- <a class="btn-link text-uppercase xsmall"
href="https://cayenne.apache.org/news";>
- More news
- <i class="fa fa-lg fa-long-arrow-right"
aria-hidden="true"></i>
- </a>
- </div>
- </div>
- <hr class="mt-0 mb-3" />
- <p class="copy xsmall text-center mw-75 mx-auto mb-0">
- Copyright © 2001-2026 Apache Software Foundation. Apache Cayenne,
Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo
are trademarks of The Apache Software Foundation.
- <a
href="https://privacy.apache.org/policies/privacy-policy-public.html";>Privacy
policy</a>.
- <img class="d-block mx-auto mt-2"
src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" />
- </p>
- </div>
-</footer>
- </body>
-</html>
diff --git
a/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne/index.html
b/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne/index.html
index b2fe730d5..6fbbcca54 100644
--- a/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne/index.html
+++ b/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/orderings/index.html
b/docs/5.0/cayenne-guide/orderings/index.html
index 3377749f3..f8c51d69a 100644
--- a/docs/5.0/cayenne-guide/orderings/index.html
+++ b/docs/5.0/cayenne-guide/orderings/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/overview/index.html
b/docs/5.0/cayenne-guide/overview/index.html
index 48657af61..f8a500c9b 100644
--- a/docs/5.0/cayenne-guide/overview/index.html
+++ b/docs/5.0/cayenne-guide/overview/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/performance-tuning/index.html
b/docs/5.0/cayenne-guide/performance-tuning/index.html
index 23a505127..bbb0954e5 100644
--- a/docs/5.0/cayenne-guide/performance-tuning/index.html
+++ b/docs/5.0/cayenne-guide/performance-tuning/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/persistent-objects-objectcontext/index.html
b/docs/5.0/cayenne-guide/persistent-objects-objectcontext/index.html
index efb724ace..90b46dbb8 100644
--- a/docs/5.0/cayenne-guide/persistent-objects-objectcontext/index.html
+++ b/docs/5.0/cayenne-guide/persistent-objects-objectcontext/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/queries/index.html
b/docs/5.0/cayenne-guide/queries/index.html
index 0e56ce5ac..beda63bfa 100644
--- a/docs/5.0/cayenne-guide/queries/index.html
+++ b/docs/5.0/cayenne-guide/queries/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/re-filtering/index.html
b/docs/5.0/cayenne-guide/re-filtering/index.html
index 90a773c47..22419dca1 100644
--- a/docs/5.0/cayenne-guide/re-filtering/index.html
+++ b/docs/5.0/cayenne-guide/re-filtering/index.html
@@ -246,12 +246,6 @@
-
-
-
-
-
-
@@ -282,8 +276,6 @@
-
-
diff --git a/docs/5.0/cayenne-guide/re-introduction/index.html
b/docs/5.0/cayenne-guide/re-introduction/index.html
index 092f2ed95..1b85e65f5 100644
--- a/docs/5.0/cayenne-guide/re-introduction/index.html
+++ b/docs/5.0/cayenne-guide/re-introduction/index.html
@@ -244,12 +244,6 @@
-
-
-
-
-
-
@@ -282,8 +276,6 @@
-
-
diff --git a/docs/5.0/cayenne-guide/re-modeler/index.html
b/docs/5.0/cayenne-guide/re-modeler/index.html
index 315b8c852..b04e652fd 100644
--- a/docs/5.0/cayenne-guide/re-modeler/index.html
+++ b/docs/5.0/cayenne-guide/re-modeler/index.html
@@ -250,12 +250,6 @@
-
-
-
-
-
-
@@ -282,8 +276,6 @@
-
-
diff --git a/docs/5.0/cayenne-guide/re-relationships-loading-control/index.html
b/docs/5.0/cayenne-guide/re-relationships-loading-control/index.html
index 7c7273cd6..995e1da1a 100644
--- a/docs/5.0/cayenne-guide/re-relationships-loading-control/index.html
+++ b/docs/5.0/cayenne-guide/re-relationships-loading-control/index.html
@@ -248,12 +248,6 @@
-
-
-
-
-
-
@@ -282,8 +276,6 @@
-
-
diff --git a/docs/5.0/cayenne-guide/setup/index.html
b/docs/5.0/cayenne-guide/setup/index.html
index 1522091de..b727e863b 100644
--- a/docs/5.0/cayenne-guide/setup/index.html
+++ b/docs/5.0/cayenne-guide/setup/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/docs/5.0/cayenne-guide/starting-cayenne/index.html
b/docs/5.0/cayenne-guide/starting-cayenne/index.html
index 34d0ab18d..a202ebef9 100644
--- a/docs/5.0/cayenne-guide/starting-cayenne/index.html
+++ b/docs/5.0/cayenne-guide/starting-cayenne/index.html
@@ -270,14 +270,6 @@
-
-
-
-
-
-
-
-
diff --git a/sitemap.xml b/sitemap.xml
index ee6dc1ed5..ae1b76c6b 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -145,21 +145,12 @@
<url>
<loc>https://cayenne.apache.org/docs/5.0/cayenne-guide/apache-cayenne-claude-code-plugin/</loc>
</url>
- <url>
-
<loc>https://cayenne.apache.org/docs/5.0/cayenne-guide/installing-apache-cayenne-plugin-claude-code/</loc>
- </url>
<url>
<loc>https://cayenne.apache.org/docs/5.0/cayenne-guide/cayenne-mcp-server/</loc>
</url>
- <url>
-
<loc>https://cayenne.apache.org/docs/5.0/cayenne-guide/installing-the-cayenne-mcp-server/</loc>
- </url>
<url>
<loc>https://cayenne.apache.org/docs/5.0/cayenne-guide/db-first-flow/</loc>
</url>
- <url>
- <loc>https://cayenne.apache.org/docs/5.0/cayenne-guide/mcp-tools/</loc>
- </url>
<url>
<loc>https://cayenne.apache.org/docs/5.0/cayenne-guide/re-introduction/</loc>
</url>
@@ -178,9 +169,6 @@
<url>
<loc>https://cayenne.apache.org/docs/5.0/cayenne-guide/ext-cache-invalidation/</loc>
</url>
- <url>
-
<loc>https://cayenne.apache.org/docs/5.0/cayenne-guide/ext-commit-log/</loc>
- </url>
<url>
<loc>https://cayenne.apache.org/docs/5.0/cayenne-guide/ext-crypto/</loc>
</url>
![https://static.scarf.sh/a.png?x-pxid=5c836e39-be6b-4a21-a946-a97b5b69f172"](https://static.scarf.sh/a.png?x-pxid=5c836e39-be6b-4a21-a946-a97b5b69f172"){kind=link}