Skip to content

Commit d1e6d2c

Browse files
committed
cosmetics
1 parent 7eae457 commit d1e6d2c

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The server helps AI models answer questions like:
1313
- _How do I add columns to a select statement in CAP Node.js?_
1414

1515
> [!NOTE]
16-
> This project is in alpha state. Do not use for production code.
16+
> This project is in alpha state. Don't use it for production code.
1717
1818
## Available Tools
1919

@@ -37,15 +37,17 @@ Search [CAP documentation](https://cap.cloud.sap) for:
3737

3838
## Setup
3939

40+
To use the CAP MCP server, install the npm package `@cap-js/mcp-server` globally:
41+
4042
```sh
41-
npm i -g @cap-js/mcp-server
42-
```
43+
npm i -g @cap-js/mcp-server # provides the cds-mcp command
4344

44-
This will provide the command `cds-mcp` to start the CAP MCP server.
45+
cds-mcp # starts the CAP MCP Server
46+
```
4547

4648
## Usage
4749

48-
Configure your MCP client (Claude Code, opencode, etc.) to start the server with command `cds-mcp`.
50+
Configure your MCP client (Claude Code, opencode, and so on) to start the server with command `cds-mcp`.
4951

5052
Example for opencode:
5153

@@ -99,19 +101,19 @@ The fuzzy search algorithm matches definition names and allows for partial match
99101

100102
This tool uses vector embeddings to search through preprocessed CAP documentation content stored locally. The process works as follows:
101103

102-
1. **Pre-processing**: CAP documentation is chunked into semantic sections and converted to vector embeddings using a local embedding model
103-
2. **Query processing**: Your search query is also converted to an embedding vector
104-
3. **Similarity search**: The system finds documentation chunks with the highest semantic similarity to your query
104+
1. **Pre-processing**: CAP documentation is chunked into semantic sections and converted to vector embeddings using a local embedding model.
105+
2. **Query processing**: Your search query is also converted to an embedding vector.
106+
3. **Similarity search**: The system finds documentation chunks with the highest semantic similarity to your query.
105107

106108
This approach enables semantic search - you can find relevant documentation even when your query doesn't contain exact keywords from the docs.
107109

108110
## Support, Feedback, Contributing
109111

110-
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/mcp-server/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
112+
This project is open to feature requests/suggestions, bug reports, and so on, via [GitHub issues](https://github.com/cap-js/mcp-server/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
111113

112114
## Security / Disclosure
113115

114-
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cap-js/mcp-server/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
116+
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cap-js/mcp-server/security/policy) on how to report it. Please don't create GitHub issues for security-related doubts or problems.
115117

116118
## Code of Conduct
117119

@@ -123,6 +125,6 @@ Copyright 2025 SAP SE or an SAP affiliate company and @cap-js/cds-mcp contributo
123125

124126
## Acknowledgments
125127

126-
- **onnxruntime-web** is used for creating embeddings in Node.js
127-
- **@huggingface/transformers.js** for the reference implementation for the WordPiece tokenizer
128-
- **@modelcontextprotocol/sdk** provides the SDK for MCP
128+
- **onnxruntime-web** is used for creating embeddings in Node.js.
129+
- **@huggingface/transformers.js** for the reference implementation for the WordPiece tokenizer.
130+
- **@modelcontextprotocol/sdk** provides the SDK for MCP.

0 commit comments

Comments
 (0)