Skip to content

Commit 13cf930

Browse files
Add Claude Code to README (#37)
* Add Claude Code to README * Improve the overview description
1 parent 718fb3b commit 13cf930

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

+37-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# mcp-server-qdrant: A Qdrant MCP server
2+
23
[![smithery badge](https://smithery.ai/badge/mcp-server-qdrant)](https://smithery.ai/protocol/mcp-server-qdrant)
34

45
> The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open protocol that enables
@@ -12,7 +13,7 @@ This repository is an example of how to create a MCP server for [Qdrant](https:/
1213

1314
## Overview
1415

15-
A basic Model Context Protocol server for keeping and retrieving memories in the Qdrant vector search engine.
16+
An official Model Context Protocol server for keeping and retrieving memories in the Qdrant vector search engine.
1617
It acts as a semantic memory layer on top of the Qdrant database.
1718

1819
## Components
@@ -205,6 +206,41 @@ consider creating the [Cursor rules](https://docs.cursor.com/context/rules-for-a
205206
the agent produces a new code snippet.** You can restrict the rules to only work for certain file types, to avoid using
206207
the MCP server for the documentation or other types of content.
207208

209+
### Using with Claude Code
210+
211+
You can enhance Claude Code's capabilities by connecting it to this MCP server, enabling semantic search over your
212+
existing codebase.
213+
214+
#### Setting up mcp-server-qdrant
215+
216+
1. Add the MCP server to Claude Code:
217+
218+
```shell
219+
# Add mcp-server-qdrant configured for code search
220+
claude mcp add code-search \
221+
-e QDRANT_URL="http://localhost:6333" \
222+
-e COLLECTION_NAME="code-repository" \
223+
-e EMBEDDING_MODEL="sentence-transformers/all-MiniLM-L6-v2" \
224+
-e TOOL_STORE_DESCRIPTION="Store code snippets with descriptions. The 'information' parameter should contain a natural language description of what the code does, while the actual code should be included in the 'metadata' parameter as a 'code' property." \
225+
-e TOOL_FIND_DESCRIPTION="Search for relevant code snippets using natural language. The 'query' parameter should describe the functionality you're looking for." \
226+
-- uvx mcp-server-qdrant
227+
```
228+
229+
2. Verify the server was added:
230+
231+
```shell
232+
claude mcp list
233+
```
234+
235+
#### Using Semantic Code Search in Claude Code
236+
237+
Tool descriptions, specified in `TOOL_STORE_DESCRIPTION` and `TOOL_FIND_DESCRIPTION`, guide Claude Code on how to use
238+
the MCP server. The ones provided above are examples and may need to be customized for your specific use case. However,
239+
Claude Code should be already able to:
240+
241+
1. Use the `qdrant-store` tool to store code snippets with descriptions.
242+
2. Use the `qdrant-find` tool to search for relevant code snippets using natural language.
243+
208244
## Contributing
209245

210246
If you have suggestions for how mcp-server-qdrant could be improved, or want to report a bug, open an issue!

0 commit comments

Comments
 (0)