InstantDB

Provides a read-only interface to query InstantDB using a dynamic schema and environment configuration.

typescript

1

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "christophersutton-instantdb-mcp": {
      "command": "node",
      "args": [
        "/path/to/instantdb-server/build/index.js"
      ],
      "env": {
        "INSTANT_APP_ID": "YOUR_APP_ID",
        "INSTANT_APP_ADMIN_TOKEN": "YOUR_ADMIN_TOKEN"
      }
    }
  }
}

This MCP server provides a read-only interface to query InstantDB using a dynamically loaded schema and environment configuration. It exposes tools to fetch query examples, run queries, and retrieve past query details, helping you experiment with InstantDB data through your MCP client.

How to use

You connect to the InstantDB MCP server from your MCP client and use the bundled tools to explore data and run queries. Start by loading an InstantDB schema from common project locations, then supply your environment configuration from your project’s .env file. You can call the provided tools to get example queries, execute a named query, list recent queries, and retrieve a specific past query by its ID.

How to install

Prerequisites: ensure you have Node.js and npm installed on your system.

Install dependencies for the MCP server project.

npm install

Build the server so you can run it locally. This compiles the TypeScript sources into runnable JavaScript.

npm run build

During development you can enable auto-rebuild for convenience.

npm run watch

Starting and configuring the MCP server locally

Run the server locally as a stdio MCP server. The configuration provided for Claude Desktop shows how to run the server with Node.js and a prebuilt index file, including required environment variables.

Use the following start command to run the server after building.

{
  "type": "stdio",
  "name": "instantdb",
  "command": "node",
  "args": ["/path/to/instantdb-server/build/index.js"],
  "env": {
    "INSTANT_APP_ID": "your_app_id",
    "INSTANT_APP_ADMIN_TOKEN": "your_admin_token"
  }
}

Additional setup: environment and debugging

Environment variables are loaded from your project’s .env file. Essential variables include INSTANT_APP_ID and INSTANT_APP_ADMIN_TOKEN. You can place these in your environment or an .env file so the server can access them at runtime.

For development debugging of MCP server communications, you can use the MCP Inspector. Run the inspector to obtain a URL for monitoring MCP server operations.

npm run inspector

Available tools

get_examples

Returns predefined example queries for categories such as basic_read, filtering, and associations.

queryDB

Executes a named query against InstantDB using a provided query string and descriptive name.

list_queries

Retrieves history of executed queries with details like query ID, name, timestamp, and structure.

return_query

Retrieves a specific previously executed query by its unique ID for reference or reuse.