Skip to content

Commit 5514f42

Browse files
committed
chore: adapted readme
1 parent 4e681ed commit 5514f42

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ npm i -g @cap-js/mcp-server
5555

5656
This will provide the command `cds-mcp` to start the CAP MCP server.
5757

58-
Configure your MCP client (Cline, opencode, Claude Code, etc.) to start the server using the `cds-mcp` command.
58+
Configure your MCP client (Cline, opencode, Claude Code, GitHub Copilot, etc.) to start the server using the `cds-mcp` command.
5959

6060
### Usage in VS Code
6161

@@ -124,7 +124,7 @@ The server provides these tools for CAP development:
124124
Search for CDS definitions (entities, services, actions), including:
125125
- Model structure and relationships
126126
- Annotations and metadata
127-
- HTTP endpoints and OData URLs
127+
- HTTP endpoints
128128
- File locations
129129

130130
### `search_docs`
@@ -143,7 +143,7 @@ The server provides two complementary search mechanisms, optimized for different
143143

144144
### `search_model` - Compiled Model Search
145145

146-
This tool performs fuzzy searches against the compiled CDS model (Core Schema Notation).
146+
This tool performs fuzzy searches against names of definitions from the compiled CDS model (Core Schema Notation).
147147
When you run a CAP project, CDS compiles all your `.cds` files into a unified model representation that includes:
148148
- All entities, services, actions, and their relationships
149149
- Annotations and metadata
@@ -153,11 +153,10 @@ The fuzzy search algorithm matches definition names and allows for partial match
153153

154154
### `search_docs` - Embedding-Based Documentation Search
155155

156-
This tool uses vector embeddings to search through preprocessed CAP documentation stored locally. The process works as follows:
156+
This tool uses vector embeddings to search through preprocessed CAP documentation stored as embeddings locally. The process works as follows:
157157

158-
1. **Pre-processing:** CAP documentation is split into semantic sections and converted to vector embeddings.
159-
2. **Query processing:** Your search query is also converted to an embedding vector.
160-
3. **Similarity search:** The system finds documentation chunks with the highest semantic similarity to your query.
158+
1. **Query processing:** Your search query is converted to an embedding vector.
159+
2. **Similarity search:** The system finds documentation chunks with the highest semantic similarity to your query.
161160

162161
This semantic search approach enables you to find relevant documentation even when your query does not use the exact keywords found in the docs, all locally on your machine.
163162

0 commit comments

Comments
 (0)