Skip to content

Commit b41ea6d

Browse files
authored
use npx in server configs (#78)
* Update README to reflect project command changes * Fix formatting of args in README.md * Revise MCP server setup and usage instructions Updated MCP server setup instructions and clarified usage. * Update CLI usage section in README.md Clarify CLI usage instructions and remove redundancy. * Update README.md
1 parent d13e05e commit b41ea6d

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@
44

55

66

7-
> [!NOTE]
8-
> This project is in alpha state.
9-
10-
11-
127
## About This Project
138

149
A Model Context Protocol (MCP) server for the [SAP Cloud Application Programming Model (CAP)](https://cap.cloud.sap).
@@ -48,13 +43,7 @@ See [Getting Started](https://cap.cloud.sap/docs/get-started) on how to jumpstar
4843

4944
## Setup
5045

51-
```sh
52-
npm i -g @cap-js/mcp-server
53-
```
54-
55-
This will provide the command `cds-mcp` to start the CAP MCP server.
56-
57-
Configure your MCP client (Cline, opencode, Claude Code, GitHub Copilot, etc.) to start the server using the `cds-mcp` command.
46+
Configure your MCP client (Cline, opencode, Claude Code, GitHub Copilot, etc.) to start the server using the command `npx -y @cap-js/mcp-server` as in the following examples.
5847

5948
### Usage in VS Code
6049

@@ -63,8 +52,8 @@ Example for VS Code extension [Cline](https://marketplace.visualstudio.com/items
6352
{
6453
"mcpServers": {
6554
"cds-mcp": {
66-
"command": "cds-mcp",
67-
"args": [],
55+
"command": "npx",
56+
"args": ["-y", "@cap-js/mcp-server"],
6857
"env": {}
6958
}
7059
}
@@ -77,8 +66,8 @@ Example for VS Code global [mcp.json](https://code.visualstudio.com/docs/copilot
7766
{
7867
"servers": {
7968
"cds-mcp": {
80-
"command": "cds-mcp",
81-
"args": [],
69+
"command": "npx",
70+
"args": ["-y", "@cap-js/mcp-server"],
8271
"env": {},
8372
"type": "stdio"
8473
},
@@ -97,7 +86,7 @@ Example for [opencode](https://github.com/sst/opencode):
9786
"mcp": {
9887
"cds-mcp": {
9988
"type": "local",
100-
"command": ["cds-mcp"],
89+
"command": ["npx", "-y", "@cap-js/mcp-server"],
10190
"enabled": true
10291
}
10392
}
@@ -117,7 +106,13 @@ Add these rules to your existing global or project-specific [`AGENTS.md`](https:
117106

118107
### CLI Usage
119108

120-
For experimental purposes, you can also use the tools directly from the command line:
109+
You can also use the tools directly from the command line.
110+
111+
```sh
112+
npm i -g @cap-js/mcp-server
113+
```
114+
115+
This will provide the command `cds-mcp`, with which you can invoke the tools directly as follows.
121116

122117
```sh
123118
# Search for CDS model definitions

0 commit comments

Comments
 (0)