wu-sheng commented on code in PR #856: URL: https://github.com/apache/skywalking-banyandb/pull/856#discussion_r2559832392
########## docs/operation/mcp/setup.md: ########## @@ -0,0 +1,178 @@ +# Setup MCP Server + +This guide explains how to set up and use the BanyanDB MCP server from pre-built binaries or Docker images. + +## Prerequisites + +- **Node.js 20+** installed (for binary usage) +- **BanyanDB** running and accessible +- **MCP client** (e.g., Claude Desktop, MCP Inspector, or other MCP-compatible clients) + +## Using Pre-built Binary + +The MCP server binary is included in the BanyanDB release package. After extracting the release, you can find the MCP server in the `mcp` directory. + +### 1. Verify Binary + +```bash +cd mcp +node dist/index.js --help +``` + +### 2. Configure Environment Variables + +Set the following environment variables: + +- `BANYANDB_ADDRESS`: BanyanDB server address (default: `localhost:17900`). The server auto-converts gRPC port (17900) to HTTP port (17913). +- `LLM_API_KEY`: (Optional) API key for LLM-powered query generation. Falls back to pattern-based if not set. +- `LLM_BASE_URL`: (Optional) Base URL for the LLM API (default: `https://api.openai.com/v1`). Only used when `LLM_API_KEY` is set. + +**Address formats:** +- `localhost:17900` - Local BanyanDB +- `192.168.1.100:17900` - Remote server +- `banyandb.example.com:17900` - Hostname + +### 3. Configure MCP Client + +Create a configuration file for your MCP client. For example, for MCP Inspector, see [MCP client](inspector.md) - Basic Setup + +## Using Docker Image + +The MCP server is available as a Docker image for easy deployment. + +### Option 1: Pull Pre-built Image + +```bash +docker pull apache/skywalking-banyandb-mcp:latest +``` + +### Option 2: Build from Source + +If you want to build the Docker image from source: + +```bash +cd mcp + +# Build the image +docker build -t apache/skywalking-banyandb-mcp:latest . +``` + +Or using the Makefile: + +```bash +cd mcp +make docker +``` + +For more details on building, see [Build and Package Guide](build.md). Review Comment: ```suggestion ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
