Skip to content

Commit 8610adf

Browse files
committed
Updating MCP docs
1 parent 244fdb7 commit 8610adf

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part3/installingMcpServer.adoc

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,49 +14,53 @@
1414

1515
=== Installing the Cayenne MCP Server
1616

17-
The MCP server is a self-contained, stdio-based process that the AI client launches on demand. It is bundled with the platform-specific CayenneModeler and requires Java 21 or later on the system `PATH`.
17+
The MCP server is a self-contained, stdio-based process that the AI client launches on demand. It is bundled with the
18+
platform-specific CayenneModeler and requires Java 21 or later on the system `PATH`.
1819

1920
==== Finding the JAR
2021

21-
As mentioned above, the MCP server jar is a part if the CayenneModeler download (available at https://cayenne.apache.org/download/). Its location depends on the install format:
22+
As mentioned above, the MCP server jar is a part if the CayenneModeler download (available at
23+
https://cayenne.apache.org/download/). Its location depends on the install format:
2224

2325
===== macOS
2426

2527
[source]
2628
----
2729
# <install-dir> is typically "/Applications", but it can be any other directory
28-
<install-dir>/CayenneModeler.app/Contents/Resources/mcp/cayenne-mcp-server-<VERSION>.jar
30+
<install-dir>/CayenneModeler.app/Contents/Resources/mcp/CayenneMCPServer.jar
2931
----
3032

3133
===== Windows
3234

3335
[source]
3436
----
35-
<install-dir>\bin\cayenne-mcp-server-<VERSION>.jar
37+
<install-dir>\bin\CayenneMCPServer.jar
3638
----
3739

3840
===== Linux / cross-platform
3941

4042
[source]
4143
----
42-
<install-dir>/bin/cayenne-mcp-server-<VERSION>.jar
44+
<install-dir>/bin/CayenneMCPServer.jar
4345
----
4446

4547
==== Configuring AI clients
4648

47-
The server communicates over stdio and is launched on demand by the client. In the snippets below, replace `/path/to/cayenne-mcp-server-<VERSION>.jar` with the actual jar path from the previous section.
49+
The server communicates over stdio and is launched on demand by the client. In the snippets below, replace
50+
`/path/to/CayenneMCPServer.jar` with the actual jar path from the previous section.
4851

4952
===== Claude Code
5053

51-
By default `claude mcp add` registers the server for the current project only. Use `--scope user` to make it available across all projects for your OS user:
54+
By default `claude mcp add` registers the server for the current project only. Use `--scope user` to make it available
55+
across all projects for your OS user:
5256

5357
[source,bash]
5458
----
5559
# Current project only
56-
claude mcp add cayenne -- java -jar /path/to/cayenne-mcp-server-<VERSION>.jar
60+
claude mcp add cayenne -- java -jar /path/to/CayenneMCPServer.jar
5761
5862
# All projects for the current user
59-
claude mcp add cayenne --scope user -- java -jar /path/to/cayenne-mcp-server-<VERSION>.jar
63+
claude mcp add cayenne --scope user -- java -jar /path/to/CayenneMCPServer.jar
6064
----
6165

6266
===== Cursor
@@ -69,7 +73,7 @@ Edit `~/.cursor/mcp.json` (global, all projects) or `.cursor/mcp.json` in your p
6973
"mcpServers": {
7074
"cayenne": {
7175
"command": "java",
72-
"args": ["-jar", "/path/to/cayenne-mcp-server-<VERSION>.jar"]
76+
"args": ["-jar", "/path/to/CayenneMCPServer.jar"]
7377
}
7478
}
7579
}
@@ -83,6 +87,6 @@ Add a `[mcp_servers.cayenne]` entry to `~/.codex/config.toml`:
8387
----
8488
[mcp_servers.cayenne]
8589
command = "java"
86-
args = ["-jar", "/path/to/cayenne-mcp-server-<VERSION>.jar"]
90+
args = ["-jar", "/path/to/CayenneMCPServer.jar"]
8791
----
8892

0 commit comments

Comments
 (0)