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
commit 66b402cee9374dc9dc79d0829e8c95b8f53380ee Author: Andrus Adamchik <[email protected]> AuthorDate: Thu May 21 15:45:09 2026 -0400 CAY-2946 Claude Code "plugin" for agentic coding with Cayenne apache headers for .md files --- ai-plugin/README.md | 18 ++++++++++++++++++ ai-plugin/references/cgen-config.md | 18 ++++++++++++++++++ ai-plugin/references/datamap-schema.md | 18 ++++++++++++++++++ ai-plugin/references/dbimport-config.md | 18 ++++++++++++++++++ ai-plugin/references/mcp-tools.md | 18 ++++++++++++++++++ ai-plugin/references/project-descriptor-schema.md | 18 ++++++++++++++++++ ai-plugin/references/project-layout.md | 18 ++++++++++++++++++ ai-plugin/references/query-api.md | 18 ++++++++++++++++++ ai-plugin/references/runtime-api.md | 18 ++++++++++++++++++ ai-plugin/skills/cayenne-cgen/SKILL.md | 18 ++++++++++++++++++ ai-plugin/skills/cayenne-modeler/SKILL.md | 18 ++++++++++++++++++ ai-plugin/skills/cayenne-modeling/SKILL.md | 18 ++++++++++++++++++ ai-plugin/skills/cayenne-query/SKILL.md | 18 ++++++++++++++++++ ai-plugin/skills/cayenne-reverse-engineer/SKILL.md | 18 ++++++++++++++++++ ai-plugin/skills/cayenne-runtime/SKILL.md | 18 ++++++++++++++++++ 15 files changed, 270 insertions(+) diff --git a/ai-plugin/README.md b/ai-plugin/README.md index 8a767e7e5..c324174f5 100644 --- a/ai-plugin/README.md +++ b/ai-plugin/README.md @@ -1,3 +1,21 @@ +<!-- + 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. +--> # apache-cayenne — Claude Code plugin Apache Cayenne ORM workflows for Claude Code. diff --git a/ai-plugin/references/cgen-config.md b/ai-plugin/references/cgen-config.md index f085e9de0..cd8c22b8d 100644 --- a/ai-plugin/references/cgen-config.md +++ b/ai-plugin/references/cgen-config.md @@ -1,3 +1,21 @@ +<!-- + 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. +--> # Class generation config (`<cgen>`) Reference for the embedded `<cgen>` block inside a DataMap that drives `mcp__cayenne__cgen_run`. diff --git a/ai-plugin/references/datamap-schema.md b/ai-plugin/references/datamap-schema.md index 3c670d2c1..c38e59fd7 100644 --- a/ai-plugin/references/datamap-schema.md +++ b/ai-plugin/references/datamap-schema.md @@ -1,3 +1,21 @@ +<!-- + 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. +--> # DataMap XML schema (`*.map.xml`) Reference for editing Cayenne DataMap files directly. diff --git a/ai-plugin/references/dbimport-config.md b/ai-plugin/references/dbimport-config.md index 5675ec487..9dd3beacb 100644 --- a/ai-plugin/references/dbimport-config.md +++ b/ai-plugin/references/dbimport-config.md @@ -1,3 +1,21 @@ +<!-- + 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. +--> # Reverse-engineering config (`<dbImport>`) Reference for the options shown by the CayenneModeler reverse-engineering wizard, persisted as a `<dbImport>` block inside a DataMap. diff --git a/ai-plugin/references/mcp-tools.md b/ai-plugin/references/mcp-tools.md index 6e9ec2f56..c8ab872bc 100644 --- a/ai-plugin/references/mcp-tools.md +++ b/ai-plugin/references/mcp-tools.md @@ -1,3 +1,21 @@ +<!-- + 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. +--> # Cayenne MCP tools The Cayenne MCP server (`cayenne-mcp-server` module) exposes Cayenne operations to AI agents over stdio. diff --git a/ai-plugin/references/project-descriptor-schema.md b/ai-plugin/references/project-descriptor-schema.md index b8833a8e3..d244e59f1 100644 --- a/ai-plugin/references/project-descriptor-schema.md +++ b/ai-plugin/references/project-descriptor-schema.md @@ -1,3 +1,21 @@ +<!-- + 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. +--> # Project descriptor XML schema (`cayenne-*.xml`) Reference for editing the top-level Cayenne project descriptor. diff --git a/ai-plugin/references/project-layout.md b/ai-plugin/references/project-layout.md index 4fba3528a..1adcf189d 100644 --- a/ai-plugin/references/project-layout.md +++ b/ai-plugin/references/project-layout.md @@ -1,3 +1,21 @@ +<!-- + 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. +--> # Cayenne project layout How a Cayenne project lays out on disk and how to locate the relevant files in a user's repo. diff --git a/ai-plugin/references/query-api.md b/ai-plugin/references/query-api.md index 1808c73cd..cd39f3f7c 100644 --- a/ai-plugin/references/query-api.md +++ b/ai-plugin/references/query-api.md @@ -1,3 +1,21 @@ +<!-- + 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. +--> # Query API reference How to fetch and filter persistent objects with Cayenne 5.0. diff --git a/ai-plugin/references/runtime-api.md b/ai-plugin/references/runtime-api.md index 5ccc20b97..30e510a84 100644 --- a/ai-plugin/references/runtime-api.md +++ b/ai-plugin/references/runtime-api.md @@ -1,3 +1,21 @@ +<!-- + 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. +--> # Runtime API reference How to bootstrap Cayenne in a Java application and use `ObjectContext` for CRUD. diff --git a/ai-plugin/skills/cayenne-cgen/SKILL.md b/ai-plugin/skills/cayenne-cgen/SKILL.md index 64c9a3133..8c9ee054b 100644 --- a/ai-plugin/skills/cayenne-cgen/SKILL.md +++ b/ai-plugin/skills/cayenne-cgen/SKILL.md @@ -3,6 +3,24 @@ name: cayenne-cgen description: "Use this skill whenever the user wants to (re)generate Cayenne entity Java classes from a DataMap. Trigger on phrases like 'generate Java classes', 'regenerate entities', 'run cgen', 'create the entity classes', 'why is the Artist class missing fields', 'where did the `_Abstract*` classes come from', 'sync the entity classes with the model', or any request to materialize Java from the DataMap. Also trigger as a follow-up after modeling changes (someone added an entity, attr [...] --- +<!-- + 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. +--> # cayenne-cgen Run Cayenne's class generator on a DataMap via the `mcp__cayenne__cgen_run` MCP tool. Reads the embedded `<cgen>` block in the DataMap to determine destination, mode, templates, etc. diff --git a/ai-plugin/skills/cayenne-modeler/SKILL.md b/ai-plugin/skills/cayenne-modeler/SKILL.md index 76d52e3f1..aac7b5d6f 100644 --- a/ai-plugin/skills/cayenne-modeler/SKILL.md +++ b/ai-plugin/skills/cayenne-modeler/SKILL.md @@ -3,6 +3,24 @@ name: cayenne-modeler description: "Use this skill when the user explicitly wants to open CayenneModeler (the GUI) on a Cayenne project, or when the modeling task is inherently visual — reverse engineering (delegated to cayenne-reverse-engineer), bulk relationship layout, multi-entity visual refactoring. Trigger on phrases like 'open the Modeler', 'open in CayenneModeler', 'launch the GUI', 'edit visually', 'show me the project in the Modeler'. Do NOT trigger as a fallback for ordinary a-la-carte XML edits — [...] --- +<!-- + 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. +--> # cayenne-modeler Launch CayenneModeler with a Cayenne project file pre-loaded, via the `mcp__cayenne__open_project` MCP tool. diff --git a/ai-plugin/skills/cayenne-modeling/SKILL.md b/ai-plugin/skills/cayenne-modeling/SKILL.md index 91735e8e0..0275d6441 100644 --- a/ai-plugin/skills/cayenne-modeling/SKILL.md +++ b/ai-plugin/skills/cayenne-modeling/SKILL.md @@ -3,6 +3,24 @@ name: cayenne-modeling description: "Use this skill whenever the user wants to edit, inspect, or extend the Cayenne ORM model in a project — adding or modifying entities, attributes, relationships, embeddables, named queries, stored procedures, or DataNodes. Trigger on phrases like 'add an ObjEntity', 'add a DbEntity', 'add a relationship', 'expose this column as an attribute', 'create a new DataMap', 'add a named query', 'create an embeddable', 'add a stored procedure', 'change the attribute type', 'mark this [...] --- +<!-- + 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. +--> # cayenne-modeling Edit Cayenne DataMap (`*.map.xml`) and project descriptor (`cayenne-*.xml`) files directly. This is the **default path** for granular model changes — adding one entity, one relationship, one query. Use the Modeler GUI (`cayenne-modeler` skill) only for inherently visual work like reverse engineering. diff --git a/ai-plugin/skills/cayenne-query/SKILL.md b/ai-plugin/skills/cayenne-query/SKILL.md index ef3c98ed7..477dc1e93 100644 --- a/ai-plugin/skills/cayenne-query/SKILL.md +++ b/ai-plugin/skills/cayenne-query/SKILL.md @@ -3,6 +3,24 @@ name: cayenne-query description: "Use this skill whenever the user wants to write or modify a Cayenne query — fetching entities by criteria, joining, prefetching to avoid N+1, ordering, paginating, aggregating, or running raw SQL through Cayenne. Trigger on phrases like 'query for X', 'fetch all artists where ...', 'write an ObjectSelect', 'use SQLSelect', 'use SelectById', 'add a prefetch', 'get distinct values', 'count rows', 'find by ID', 'load by primary key', 'build a Cayenne expression', 'why am I get [...] --- +<!-- + 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. +--> # cayenne-query Write idiomatic Cayenne 5.0 queries — `ObjectSelect`, `SelectById`, `SQLSelect`, expressions, prefetch, pagination, aggregates. diff --git a/ai-plugin/skills/cayenne-reverse-engineer/SKILL.md b/ai-plugin/skills/cayenne-reverse-engineer/SKILL.md index 4f22c628a..0c6d8dcbc 100644 --- a/ai-plugin/skills/cayenne-reverse-engineer/SKILL.md +++ b/ai-plugin/skills/cayenne-reverse-engineer/SKILL.md @@ -3,6 +3,24 @@ name: cayenne-reverse-engineer description: "Use this skill whenever the user wants to import database schema metadata into a Cayenne DataMap — full-schema sync from a live DB. Trigger on phrases like 'reverse engineer the database', 'import the schema', 'generate a DataMap from my DB', 'sync the model with the database', 'add the new tables from the DB', 'import the customer table', 'pick up the latest schema changes', 'create entities from these tables', or any request that involves reading database metadata to popu [...] --- +<!-- + 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. +--> # cayenne-reverse-engineer Import a database schema into a Cayenne DataMap by driving the CayenneModeler's reverse-engineering wizard through MCP. Cayenne 5.0 does not yet expose reverse engineering as a direct MCP tool, so the workflow launches the GUI and walks the user through the wizard. diff --git a/ai-plugin/skills/cayenne-runtime/SKILL.md b/ai-plugin/skills/cayenne-runtime/SKILL.md index e46ccfadc..21488f027 100644 --- a/ai-plugin/skills/cayenne-runtime/SKILL.md +++ b/ai-plugin/skills/cayenne-runtime/SKILL.md @@ -3,6 +3,24 @@ name: cayenne-runtime description: "Use this skill whenever the user wants to bootstrap Cayenne in a Java application — constructing a CayenneRuntime, wiring a DataSource, configuring connection pools, creating ObjectContexts, or integrating Cayenne with a DI container (Bootique, Spring, plain Java). Trigger on phrases like 'set up Cayenne in my app', 'configure CayenneRuntime', 'wire Cayenne into Bootique/Spring', 'create an ObjectContext', 'configure a DataSource for Cayenne', 'connect Cayenne to Postgres/M [...] --- +<!-- + 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. +--> # cayenne-runtime Bootstrap `CayenneRuntime` and use `ObjectContext` for CRUD in a Java application.
