bunqueue v2.9 API referenceall versions ยท guide
bunqueue
    Preparing search index...

    Function launch

    • bunqueue MCP Server

      Model Context Protocol server for bunqueue job queue management. Uses the official @modelcontextprotocol/sdk for protocol compliance.

      Supports two connection modes:

      • embedded (default): In-memory or direct SQLite access via QueueManager
      • tcp: Connect to a remote memory/SQLite or PostgreSQL-backed server

      Returns Promise<void>

      {
      "mcpServers": {
      "bunqueue": {
      "command": "bunx",
      "args": ["--package=bunqueue", "bunqueue-mcp"],
      "env": { "DATA_PATH": "./data/bunq.db" }
      }
      }
      }
      {
      "mcpServers": {
      "bunqueue": {
      "command": "bunx",
      "args": ["--package=bunqueue", "bunqueue-mcp"],
      "env": {
      "BUNQUEUE_MODE": "tcp",
      "BUNQUEUE_HOST": "localhost",
      "BUNQUEUE_PORT": "6789",
      "BUNQUEUE_TOKEN": "secret"
      }
      }
      }
      }

      Two transports, independent of the connection mode:

      • stdio (default): one client over stdin/stdout, as in the examples above
      • http (opt-in): MCP Streamable HTTP for several concurrent clients, one session each, sharing a single backend
      BUNQUEUE_MCP_TRANSPORT=http BUNQUEUE_MCP_HTTP_TOKEN=secret bunx --package=bunqueue bunqueue-mcp
      # stderr: bunqueue MCP server started (mode: embedded, transport: http,
      # url: http://127.0.0.1:6791/mcp, version: X)

      Clients send Authorization: Bearer secret. A non-loopback BUNQUEUE_MCP_HTTP_HOST requires BUNQUEUE_MCP_HTTP_TOKEN.