Milvus SDK Code Helper

You run a Milvus code helper MCP server that gathers relevant Milvus code examples and documents to help you generate PyMilvus code. It adapts to how you connect to Milvus and how you receive results, making it easier to produce correct, up-to-date code snippets for your projects.

How to use

Choose an MCP client that supports MCPs (for example, a Cursor client, Claude Desktop, Claude Code in VS Code, or Gemini CLI). You can connect via HTTP or via local stdio to run the MCP server on your machine. The server provides three tools to help you generate and translate Milvus code: generate PyMilvus samples from natural language, convert ORM-style code to PyMilvus client code, and translate code between languages. Start by registering the server endpoint with your MCP client, then describe your code need in plain language.

• HTTP transport (recommended): your MCP client talks to a remote HTTP endpoint. This is the simplest setup when you have a server exposed at a URL like http://localhost:8000/mcp. The server will fetch and index the latest Milvus documentation and expose three main capabilities. - STDIO transport: you run a local command that starts the MCP server, and your client communicates via standard input/output. This is useful when you want tighter control over the runtime or when you operate in environments that favor local processes.

How to install

Prerequisites you need before running the MCP server are straightforward.

• Ensure Python 3.10 or higher is available on your system.

• Have a Milvus instance running locally or remotely and ensure you can reach http://localhost:19530 by default. If your Milvus URI is different, you will provide it during startup.

• Install uv if you want to run the server in FastMCP style, which is the recommended approach for best performance.

Step-by-step commands to start with the recommended approach.

Additional sections

Configuration options define how the MCP server connects to Milvus and how it serves requests. You can tune the Milvus URI, the host and port for the local MCP server, and the transport protocol you use.

Security considerations include providing your Milvus authentication token if required and ensuring your MCP endpoint is not exposed publicly without proper safeguards.

Examples show how to connect from clients that expect different transports and how to supply environment variables like OPENAI_API_KEY when running in STDIO mode.

Troubleshooting tips cover common issues such as connectivity to Milvus, authentication failures, port conflicts, and ensuring documents are loaded before querying results.

Tools you can access on this MCP server include: - milvus_code_generator: generate or provide sample PyMilvus/Milvus code from natural language requests. - orm_client_code_convertor: convert between ORM and PyMilvus client code. - milvus_code_translator: translate Milvus code between programming languages.

Configuration snippets for MCP clients

{
  "mcpServers": {
    "milvus_sdk_code_helper": {
      "type": "http",
      "url": "http://localhost:8000/mcp",
      "args": []
    }
  }
}

{
  "mcpServers": {
    "milvus_sdk_code_helper": {
      "type": "stdio",
      "command": "/PATH/TO/uv",
      "args": [
        "--directory",
        "/path/to/milvus-sdk-code-helper",
        "run",
        "examples/fastmcp_server.py",
        "--transport",
        "stdio",
        "--milvus_uri",
        "http://localhost:19530"
      ],
      "env": {
        "OPENAI_API_KEY": "YOUR_OPENAI_API_KEY"
      }
    }
  }
}

Notes on environment and transport

OpenAI API access is typically needed for document processing and embedding generation, so you should provide OPENAI_API_KEY when running the STDIO transport. If you choose HTTP transport, you may not need to configure OPENAI_API_KEY in the same way.

Available tools

milvus_code_generator

Generate or provide sample PyMilvus/Milvus code based on natural language input. Useful for code generation, sample requests, and how-to queries.

orm_client_code_convertor

Convert between ORM and PyMilvus client code formats. Helps adapt code styles and formats.

milvus_code_translator

Translate Milvus code between programming languages for cross-language portability.