Frequently Asked Questions (FAQ)

Q: What is the BlazeSQL MCP Server? A: The BlazeSQL MCP Server is a proxy that allows MCP-compatible clients (like Cursor or Claude 3) to interact with the BlazeSQL Natural Language Query API using natural language.

Q: What is MCP? A: MCP stands for Model Context Protocol. It’s an open protocol that standardizes how applications provide context to LLMs (Large Language Models).

Q: What are the prerequisites for running the BlazeSQL MCP Server? A: You need Node.js, Yarn, a BlazeSQL account with an API Key (Team Advanced subscription required), and at least one database connection configured in your BlazeSQL account.

Q: How do I install the BlazeSQL MCP Server? A: Clone the repository, install dependencies using yarn install, configure the .env file with your BlazeSQL API key, build the server using yarn build, and run the server using node build/index.js.

Q: How do I connect an MCP client to the server? A: The server uses the stdio transport mechanism. You can use the MCP Inspector for testing or configure integrated clients (Cursor, Claude 3, etc.) by specifying the correct command to run the server (including the absolute paths to Node.js and the build/index.js file).

Q: What is the blazesql_query tool? A: It’s the MCP tool exposed by the server that allows you to execute natural language queries against your database. It requires the db_id and natural_language_request arguments.

Q: How do I find my db_id? A: You can find the database ID in the BlazeSQL web application when managing your database connections.

Q: What kind of output does the blazesql_query tool provide? A: If successful, the tool returns a text content block containing the natural language response from the BlazeSQL agent, the generated SQL query, and the data results formatted as JSON, all within Markdown code fences. If unsuccessful, it returns an error message.

Q: What if I get an error when calling the blazesql_query tool? A: The tool will return a text content block containing the error message from the BlazeSQL API and mark the response as an error (isError: true).

Q: Where do I get my BlazeSQL API Key? A: You can obtain your API key from your BlazeSQL account settings. A Team Advanced subscription is required for API access.

Q: Can I use this with other databases besides BlazeSQL? A: No, this MCP server is specifically designed to work with the BlazeSQL Natural Language Query API.

Q: What is UBOS and how does this integrate with it? A: UBOS is a full-stack AI Agent Development Platform. Integrating the BlazeSQL MCP Server allows you to equip your AI Agents with natural language database querying capabilities, enabling them to access and analyze real-time data for more informed decisions and automated tasks.