instantdb-server MCP Server

instantdb-server MCP Server

site icon
2025.03.08 0
TypeScript数据库查询开发工具数据库
instantdb-mcp 是一个用于与 InstantDB 交互的 MCP 服务器。它提供了一个只读接口,用于查询 InstantDB,支持动态加载的模式和环境配置。该服务器包括执行查询和检索基于预定义模式的查询示例的工具。
View on GitHub

Overview

基本能力

产品定位

instantdb-mcp 是一个用于与 InstantDB 交互的 MCP 服务器,提供只读查询接口和查询示例功能。

核心功能

  1. 工具集
  2. get_examples:返回预定义的查询示例,适用于不同类别(如 "basic_read", "filtering", "associations")。
  3. queryDB:执行特定的 InstantDB 查询,需要 queryname 参数。
  4. list_queries:检索执行过的查询历史,包括查询 ID、名称、时间戳和结构。
  5. return_query:通过唯一 ID 检索特定查询以供后续参考或实现。

  6. 模式和环境集成

  7. 动态加载 InstantDB 模式,支持从项目目录的常见文件位置加载(如 instant.schema.ts, src/instant.schema.ts, app/instant.schema.ts)。
  8. 从项目的 .env 文件加载环境变量配置,包括 INSTANT_APP_IDINSTANT_APP_ADMIN_TOKEN

  9. 待实现功能

  10. 动态检测 InstantDB 权限文件。

适用场景

  • 需要快速查询 InstantDB 的场景。
  • 需要获取预定义查询示例以加速开发的场景。
  • 需要记录和检索查询历史的场景。

使用教程

使用依赖

安装依赖:

npm install

安装教程

构建服务器:

npm run build

开发时自动重建:

npm run watch

在 Claude Desktop 中使用服务器,需在配置文件中添加以下内容:

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

示例配置:

{
  "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": []
    }
  }
}

调试方式

调试 MCP 服务器通信:

npm run inspector

检查器将提供一个 URL 用于监控 MCP 服务器操作。

许可证

None