What is the StarRocks MCP Server?

The StarRocks MCP Server is a Model Control Protocol (MCP) server that provides a standardized interface for AI models to query and manipulate StarRocks databases.

What is MCP (Model Control Protocol)?

MCP is an open protocol that standardizes how applications provide context to LLMs. It enables AI models to interact with external data sources and tools in a structured and secure manner.

What are the prerequisites for installing the StarRocks MCP Server?

You need Python 3.8+, a StarRocks database instance, SQLAlchemy, and the MCP Python library.

How do I install the StarRocks MCP Server from source?

Clone the repository, navigate to the directory, and run pip install -e ..

How do I start the StarRocks MCP Server?

Use the command: python -m mcp_server_starrocks.server --host <starrocks-host> --port <starrocks-port> --user <username> --database <database-name> [--password <password>] [--readonly]

What are the available tools provided by the server?

The server provides read-query, list-tables, describe-table, and, when not in read-only mode, write-query and create-table.

What does the read-query tool do?

The read-query tool executes a SELECT query on the StarRocks database.

What does the list-tables tool do?

The list-tables tool lists all tables in the StarRocks database.

What does the describe-table tool do?

The describe-table tool describes the schema of a specific table.

What do the write-query and create-table tools do?

The write-query tool executes INSERT, UPDATE, or DELETE queries, and the create-table tool creates a new table in the StarRocks database. These are only available when the server is not in read-only mode.

How do I run the server in read-only mode?

Use the --readonly flag when starting the server.

Where can I find more information about UBOS?

UBOS is a Full-stack AI Agent Development Platform focused on bringing AI Agents to every business department. Visit https://ubos.tech for more details.