Skip to content

Commit 952f6e9

Browse files
committed
CAY-2946 Claude Code "plugin" for agentic coding with Cayenne
1 parent 2b0e3e1 commit 952f6e9

2 files changed

Lines changed: 35 additions & 6 deletions

File tree

.claude-plugin/marketplace.json

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"name": "apache-cayenne",
3+
"metadata": {
4+
"description": "Apache Cayenne ORM Claude Code plugins"
5+
},
6+
"owner": {
7+
"name": "Apache Cayenne"
8+
},
9+
"plugins": [
10+
{
11+
"name": "apache-cayenne",
12+
"description": "Apache Cayenne 5.0 ORM — design DataMaps, reverse-engineer schemas, generate classes, write runtime code.",
13+
"author": { "name": "Apache Cayenne" },
14+
"source": {
15+
"type": "git",
16+
"repo": "apache/cayenne",
17+
"path": "ai-plugin"
18+
},
19+
"category": "development",
20+
"tags": ["java", "orm", "cayenne", "database"]
21+
}
22+
]
23+
}

ai-plugin/README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,24 @@ This plugin teaches Claude how to:
1111

1212
The plugin assumes downstream **users of Cayenne** writing their own Java apps. It does *not* cover contributor workflows for hacking on Cayenne itself.
1313

14-
## First-time setup
14+
## Install
1515

16-
> **Cayenne 5.0+ only.** The MCP server ships with Cayenne 5.0. Skills that depend on it (`cayenne-cgen`, `cayenne-modeler`, `cayenne-reverse-engineer`) will not work against earlier Cayenne versions — there is no MCP server to register. The XML-editing skills (`cayenne-modeling`) and runtime/query skills target Cayenne 5.0 idioms too; for older Cayenne, this plugin is not the right tool.
16+
**Cayenne 5.0+ only.** The MCP server ships with Cayenne 5.0. Skills that depend on it (`cayenne-cgen`, `cayenne-modeler`, `cayenne-reverse-engineer`) will not work against earlier Cayenne versions. The XML-editing, runtime, and query skills also target 5.0 idioms for older Cayenne, this plugin is not the right tool.
1717

18-
1. **Register the Cayenne MCP server.** Class generation (`cgen_run`) and opening the Modeler GUI (`open_project`) both go through this server.
19-
TODO: Full instructions will be on the website shorly.
18+
The plugin is distributed from the Apache Cayenne GitHub repository: **https://github.com/apache/cayenne**. Inside Claude Code:
2019

21-
```bash
20+
```
21+
# register the "marketplace"
22+
/plugin marketplace add apache/cayenne
23+
24+
# install the plugin
25+
/plugin install apache-cayenne@apache-cayenne
26+
27+
# Install the MCP server (requires a local CayenneModeler install)
2228
claude mcp add cayenne --scope user -- java -jar /path/to/cayenne-mcp-server-<VERSION>.jar
2329
```
2430

25-
2. **Verify** the server is registered with `claude mcp list` — you should see an entry named `cayenne` (the MCP server alias from the command above, separate from this plugin's `apache-cayenne` name) showing as connected.
31+
Full MCP setup instructions will be on the Cayenne website shortly.
2632

2733
That's it. The skills detect the MCP server at runtime; if it isn't connected they point back at this README instead of falling back to Maven or Gradle goals.
2834

0 commit comments

Comments
 (0)