Skip to content

Commit 7b9736c

Browse files
committed
adapt README
1 parent 9b379f7 commit 7b9736c

File tree

1 file changed

+5
-28
lines changed

1 file changed

+5
-28
lines changed

README.md

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ The server helps AI models answer questions such as:
3232
- [Available Tools](#available-tools)
3333
- [`search_model`](#search_model)
3434
- [`search_docs`](#search_docs)
35-
- [How It Works](#how-it-works)
3635
- [Support, Feedback, Contributing](#support-feedback-contributing)
3736
- [Security / Disclosure](#security--disclosure)
3837
- [Code of Conduct](#code-of-conduct)
@@ -119,41 +118,19 @@ cds-mcp search_docs "how to add columns to a select statement in CAP Node.js" 1
119118
120119
The server provides these tools for CAP development:
121120

122-
### `search_model`
123-
124-
Search for CDS definitions (entities, services, actions), including:
125-
- Model structure and relationships
126-
- Annotations and metadata
127-
- HTTP endpoints
128-
- File locations
129-
130-
### `search_docs`
131-
132-
Search [CAP documentation](https://cap.cloud.sap) for:
133-
- Code snippets and examples
134-
- API usage patterns
135-
136-
137-
138-
139-
140-
## How It Works
141-
142-
The server provides two complementary search mechanisms, optimized for different use cases:
143-
144121
### `search_model` - Compiled Model Search
145122

146123
This tool performs fuzzy searches against names of definitions from the compiled CDS model (Core Schema Notation).
147-
When you run a CAP project, CDS compiles all your `.cds` files into a unified model representation that includes:
148-
- All entities, services, actions, and their relationships
149-
- Annotations and metadata
150-
- Generated HTTP endpoints
124+
CDS compiles all your `.cds` files into a unified model representation that includes:
125+
- All definitions and their relationships
126+
- Annotations
127+
- HTTP endpoints
151128

152129
The fuzzy search algorithm matches definition names and allows for partial matches, making it easy to find entities like "Books" even when searching for "book".
153130

154131
### `search_docs` - Embedding-Based Documentation Search
155132

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

158135
1. **Query processing:** Your search query is converted to an embedding vector.
159136
2. **Similarity search:** The system finds documentation chunks with the highest semantic similarity to your query.

0 commit comments

Comments
 (0)