nds for building and running the KWDB MCP Server └── README.md # README file ``` ### Start KWDB MCP Server The KWDB MCP Server supports the following two transport modes: - StdIO (Standard Input/Output) mode: the KWDB MCP Server uses the standard input/output for communication. This is the default mode. - SSE (Server-Sent Events) mode: the KWDB MCP Server uses HTTP POST for communication between the server and the client. #### StdIO Mode - Run the KWDB MCP Server with a PostgreSQL connection string: ```shell ./bin/kwdb-mcp-server "postgresql://:@:/?sslmode=disable" ``` - Run the KWDB MCP Server using the Makefile: ```shell CONNECTION_STRING="postgresql://:@:/?sslmode=disable" make run ``` Parameters: - `username`: the username used to connect to the KWDB database - `password`: the password for the username - `hostname`: the IP address of the KWDB database - `port`: the port of the KWDB database - `database_name`: the name of the KWDB database - `sslmode`: the SSL mode, available options are `disable`, `allow`, `prefer`, `require`, `verify-ca` and `verify-full`. For details about the SSL mode, see [SSL Mode Parameters](https://www.kaiwudb.com/kaiwudb_docs/#/oss_dev/development/connect-kaiwudb/java/connect-jdbc.html#%E8%BF%9E%E6%8E%A5%E5%8F%82%E6%95%B0). #### SSE Mode To access KWDB databases deployed on other servers, you can start the KWDB MCP Server in SSE mode. > **Note** > > You need to provide the database connection string as the last parameter. - Run the KWDB MCP Server with a PostgreSQL connection string: ```shell ./bin/kwdb-mcp-server -t sse -addr ":8080" -base-url "http://localhost:8080" "postgresql://:@:/?sslmode=disable" ``` - Run the KWDB MCP Server using the Makefile: ```shell CONNECTION_STRING="postgresql://:@:/?sslmode=disable" ADDR=":8080" BASE_URL="http://localhost:8080" make run -sse ``` Parameters: - `-t` or `-transport`: the transport type, available options are `stdio` or `sse`. - `stdio`: the StdIO mode - `sse`: the SSE mode - `-addr` or `ADDR`: the listening port of the KWDB MCP Server. By default, it is set to `:8080`. - `-base-url` or `BASE_URL`: the IP address of the KWDB MCP Server. By default, it is set to `http://localhost:8080`. - `username`: the username used to connect to the KWDB database - `password`: the password for the username - `hostname`: the IP address of the KWDB database - `port`: the port of the KWDB database - `database_name`: the name of the KWDB database - `sslmode`: the SSL mode, available options are `disable`, `allow`, `prefer`, `require`, `verify-ca` and `verify-full`. For details about the SSL mode, see [SSL Mode Parameters](https://www.kaiwudb.com/kaiwudb_docs/#/oss_dev/development/connect-kaiwudb/java/connect-jdbc.html#%E8%BF%9E%E6%8E%A5%E5%8F%82%E6%95%B0). ## Integrate with LLM Agents For details about how the KWDB MCP Server integerates with LLM Agents, see [Integrate with LLM Agents](./docs/integrate-llm-agent_en.md). ## Troubleshooting For details about how to troubleshoot the KWDB MCP Server, see [Troubleshooting](./docs/troubleshooting_en.md). ## Documentation For documentation about the KWDB MCP Server, see the [KWDB Documentation Website](https://www.kaiwudb.com/kaiwudb_docs/#/oss_dev/development/connect-kaiwudb/kwdb-mcp-server/connect-kwdb-mcp-server.html). ## Future Enhancements - [ ] **Query history**: implement query history functionality. - [x] **Remote mode**: support connecting to the remote KWDB MCP Server. - [x] **Improved optimization suggestions**: enhance query optimization recommendations. - [ ] **Metrics resource**: aAdd database metrics. ## Contribution Contributions are welcome! Please feel free to submit issues and pull requests. ## License This project is licensed under the MIT License. ## Acknowledgements - [mark3labs/mcp-go](https://g

KWDB MCP Server

Comments