What is Instantdb Mcp

instantdb-mcp is an MCP server designed for interacting with InstantDB, providing a read-only interface for querying data using a dynamically loaded schema and environment configuration.

Use cases

Use cases include data retrieval for applications, generating query examples for developers, and maintaining a history of executed queries for auditing or debugging purposes.

How to use

To use instantdb-mcp, install the necessary dependencies with ‘npm install’, build the server using ‘npm run build’, and configure it in Claude Desktop by adding the appropriate settings in the configuration file.

Key features

Key features include tools for retrieving example queries, executing specific queries, listing query history, and retrieving queries by unique ID. It also supports dynamic loading of schemas and environment variable configuration.

Where to use

instantdb-mcp can be used in applications that require querying InstantDB, particularly in environments where dynamic schema loading and configuration management are essential.

instantdb-server MCP Server

An MCP server for interacting with InstantDB.

This server provides a read-only interface for querying InstantDB using a dynamically loaded schema and environment configuration. It includes tools to execute queries and retrieve query examples based on pre-defined patterns.

Features

Tools

• get_examples
  Returns pre-defined example queries for various categories (e.g., “basic_read”, “filtering”, “associations”).

• queryDB
  Executes a specific query against InstantDB. Requires a query and a descriptive name parameter.

• list_queries
  Retrieves the history of executed queries with details such as query ID, name, timestamp, and structure.

• return_query
  Retrieves a specific query by its unique ID for later reference or implementation.

Schema and Environment Integration

• Dynamic loading of the InstantDB schema from common file locations relative to a provided project directory (e.g., instant.schema.ts, src/instant.schema.ts, app/instant.schema.ts).
• Environment variable configuration is loaded from the project’s .env file. Essential variables include:
  • INSTANT_APP_ID
  • INSTANT_APP_ADMIN_TOKEN

Pending Features

• Dynamic detection of the InstantDB permissions file from common file locations.

Development

Install dependencies:

npm install

Build the server:

npm run build

For development with auto-rebuild:

npm run watch

Installation

To use the server with Claude Desktop, add the following configuration to your Claude Desktop settings:

On macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
On Windows:
%APPDATA%/Claude/claude_desktop_config.json

Example configuration:

{
  "mcpServers": {
    "instantdb-server": {
      "command": "node",
      "args": [
        "/path/to/instantdb-server/build/index.js"
      ],
      "env": {
        "INSTANT_APP_ID": "your_app_id",
        "INSTANT_APP_ADMIN_TOKEN": "your_admin_token"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

Debugging

For debugging MCP server communications, use the MCP Inspector:

npm run inspector

The Inspector will provide a URL to access tools for monitoring MCP server operations.