This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cayenne.git
The following commit(s) were added to refs/heads/master by this push:
new b5ff85bfe AI docs cleanup
b5ff85bfe is described below
commit b5ff85bfed7d321de92695834daf4481668e1f80
Author: Andrus Adamchik <[email protected]>
AuthorDate: Mon May 25 10:39:44 2026 -0400
AI docs cleanup
---
.../src/docs/asciidoc/_cayenne-guide/part3.adoc | 4 +-
.../asciidoc/_cayenne-guide/part3/installing.adoc | 94 ----------------------
.../part3/{mcpTools.adoc => mcp.adoc} | 76 +++++++++++++++--
.../asciidoc/_cayenne-guide/part3/overview.adoc | 16 ++--
.../{part3.adoc => part3/plugin.adoc} | 15 +++-
5 files changed, 92 insertions(+), 113 deletions(-)
diff --git
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3.adoc
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3.adoc
index 364698467..4e88013f3 100644
--- a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3.adoc
+++ b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3.adoc
@@ -16,6 +16,6 @@
include::part3/overview.adoc[]
-include::part3/installing.adoc[]
+include::part3/plugin.adoc[]
-include::part3/mcpTools.adoc[]
+include::part3/mcp.adoc[]
diff --git
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/installing.adoc
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/installing.adoc
deleted file mode 100644
index 3c4ec02ea..000000000
---
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/installing.adoc
+++ /dev/null
@@ -1,94 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one or more
-// contributor license agreements. See the NOTICE file distributed with
-// this work for additional information regarding copyright ownership.
-// The ASF licenses this file to you under the Apache License, Version
-// 2.0 (the "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// https://www.apache.org/licenses/LICENSE-2.0 Unless required by
-// applicable law or agreed to in writing, software distributed under the
-// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-// CONDITIONS OF ANY KIND, either express or implied. See the License for
-// the specific language governing permissions and limitations under the
-// License.
-
-
-=== Installing `apache-cayenne` Plugin (Claude Code)
-
-Install the `apache-cayenne` plugin with Cayenne-specific skills under Claude
Code:
-
-[source,bash]
-----
-/plugin marketplace add apache/cayenne
-/plugin install apache-cayenne@apache-cayenne
-/reload-plugins
-----
-
-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).
-
-=== Installing the Cayenne MCP Server
-
-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 `PATH`. So to get it, first download the Modeler at
https://cayenne.apache.org/download/ .
-
-MCP runnable jar is `CayenneMCPServer.jar`. Its location is OS-dependent (you
will need this location in the next step):
-
-Mac:
-[source]
-----
-# <install-dir> is typically "/Applications", but it can be any other directory
-<install-dir>/CayenneModeler.app/Contents/Resources/mcp/CayenneMCPServer.jar
-----
-
-Windows:
-[source]
-----
-<install-dir>\bin\CayenneMCPServer.jar
-----
-
-Linux / cross-platform:
-[source]
-----
-<install-dir>/bin/CayenneMCPServer.jar
-----
-
-When installaing the MCP, replace `/path/to/CayenneMCPServer.jar` mentioned in
the instructions with the actual jar path:
-
-==== Claude Code
-
-[source,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
-----
-
-==== Cursor
-
-Edit `~/.cursor/mcp.json` (global, all projects) or `.cursor/mcp.json` in your
project (per-project):
-[source,json]
-----
-{
- "mcpServers": {
- "cayenne": {
- "command": "java",
- "args": ["-jar", "/path/to/CayenneMCPServer.jar"]
- }
- }
-}
-----
-
-==== Codex
-Add a `[mcp_servers.cayenne]` entry to `~/.codex/config.toml`:
-
-[source,toml]
-----
-[mcp_servers.cayenne]
-command = "java"
-args = ["-jar", "/path/to/CayenneMCPServer.jar"]
-----
-
diff --git
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/mcpTools.adoc
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/mcp.adoc
similarity index 70%
rename from
docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/mcpTools.adoc
rename to
docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/mcp.adoc
index 7856c2b9e..450c66fb7 100644
---
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/mcpTools.adoc
+++
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/mcp.adoc
@@ -12,7 +12,72 @@
// the specific language governing permissions and limitations under the
// License.
-=== MCP Tools
+=== Cayenne MCP Server
+
+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 `PATH`. So to get it, first download the Modeler at
https://cayenne.apache.org/download/ .
+
+MCP runnable jar is `CayenneMCPServer.jar`. Its location is OS-dependent (you
will need this location in the next step):
+
+Mac:
+[source]
+----
+# <install-dir> is typically "/Applications", but it can be any other directory
+<install-dir>/CayenneModeler.app/Contents/Resources/mcp/CayenneMCPServer.jar
+----
+
+Windows:
+[source]
+----
+<install-dir>\bin\CayenneMCPServer.jar
+----
+
+Linux / cross-platform:
+[source]
+----
+<install-dir>/bin/CayenneMCPServer.jar
+----
+
+When installing the MCP, replace `/path/to/CayenneMCPServer.jar` mentioned in
the instructions with the actual jar path:
+
+==== Installing on Claude Code
+
+[source,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
+----
+
+==== Installing on Cursor
+
+Edit `~/.cursor/mcp.json` (global, all projects) or `.cursor/mcp.json` in your
project (per-project):
+[source,json]
+----
+{
+ "mcpServers": {
+ "cayenne": {
+ "command": "java",
+ "args": ["-jar", "/path/to/CayenneMCPServer.jar"]
+ }
+ }
+}
+----
+
+==== Installing on Codex
+Add a `[mcp_servers.cayenne]` entry to `~/.codex/config.toml`:
+
+[source,toml]
+----
+[mcp_servers.cayenne]
+command = "java"
+args = ["-jar", "/path/to/CayenneMCPServer.jar"]
+----
+
+==== Available MCP Tools
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 `cayenne-*.xml` file) and take
@@ -21,7 +86,7 @@ absolute paths — agents should resolve relative paths against
the current work
If you are using the `apache-cayenne` Claude Code plugin, its skills
(`cayenne-cgen`, `cayenne-modeler`, `cayenne-db-import`)
call these tools automatically. You can verify the server is available with
`claude mcp list` — look for an entry named `cayenne`.
-==== open_project
+===== open_project
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.
@@ -45,8 +110,7 @@ open the Cayenne project at @/path/to/cayenne-project.xml in
the Modeler.
____
-
-==== cgen_run
+===== cgen_run
Runs the Cayenne class generator (`cgen`) for a single DataMap inside the
project, using the `cgen` 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.
@@ -70,9 +134,7 @@ ____
regenerate Java classes from Cayenne model
____
-
-
-==== dbimport_run
+===== dbimport_run
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).
diff --git
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/overview.adoc
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/overview.adoc
index 57c7763c4..02c487438 100644
---
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/overview.adoc
+++
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/overview.adoc
@@ -14,11 +14,15 @@
=== Overview
-AI coding agents such as Claude Code, Cursor, etc. can read and write Cayenne
projects like any other Java codebase. For day-to-day API work — writing
queries, manipulating an `ObjectContext`, etc. — you don't need anything
Cayenne-specific. Prompt the agent the way you would for any other project.
+AI coding agents such as Claude Code, Cursor, etc. can read and write Cayenne
projects like any other Java codebase.
+For day-to-day API work — writing queries, manipulating an `ObjectContext`,
etc. — you may not need anything
+Cayenne-specific. Prompt the agent the way you would for any other project.
But two additional elements make the agent
+Cayenne-aware and allow to implement full ORM workflows:
-Two additional elements make the agent _Cayenne-aware_ beyond plain source
editing:
+* MCP server — a small stdio-based process the agent launches on demand,
exposing tools for class generation, DB import,
+and opening CayenneModeler. Works with any MCP-compatible client (Claude Code,
Cursor, Codex, etc.).
+* `apache-cayenne` Claude Code plugin — a Claude Code-specific extension that
bundles pre-built skills for DataMap
+editing, query writing, runtime setup, and more. The skills detect the MCP
server at runtime;
-* MCP server — a small stdio-based process the agent launches on demand,
exposing tools for class generation, DB import, and opening CayenneModeler.
Works with any MCP-compatible client (Claude Code, Cursor, Codex, etc.).
-* `apache-cayenne` Claude Code plugin — a Claude Code-specific extension that
bundles pre-built skills for DataMap editing, query writing, runtime setup, and
more. The skills detect the MCP server at runtime;
-
-Both elements are independent but work best together. This chapter walks you
through installing both and explains the available MCP tools.
+Both are independent but work best together. This chapter walks you through
installing both and explains the available
+MCP tools.
diff --git
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3.adoc
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/plugin.adoc
similarity index 63%
copy from
docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3.adoc
copy to
docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/plugin.adoc
index 364698467..59af6367f 100644
--- a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3.adoc
+++
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/plugin.adoc
@@ -12,10 +12,17 @@
// the specific language governing permissions and limitations under the
// License.
-== Agentic Coding
-include::part3/overview.adoc[]
+=== `apache-cayenne` Claude Code Plugin
-include::part3/installing.adoc[]
+(Claude Code specific) Install the `apache-cayenne` plugin with Cayenne skills
under Claude Code:
-include::part3/mcpTools.adoc[]
+[source,bash]
+----
+/plugin marketplace add apache/cayenne
+/plugin install apache-cayenne@apache-cayenne
+/reload-plugins
+----
+
+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).
