@imqueue

Working · 1.3 s

org.imqueue/mcpv3.7.9 Domain verified

Search @imqueue docs and scaffold typed services & clients from your AI coding agent.

Developer Tools

Source Website Registry entry

Try it

Call this server's tools from your browser. Nothing to install.

https://mcp.imqueue.org/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

get_doc

Fetch the markdown of an @imqueue documentation page by its URL (as returned by search_docs). Returns plain markdown suitable for reading and quoting. Pass a URL with a #fragment — which is what search_docs returns for a section result — to get just that section plus the heading path above it; pass the URL without one to read the whole page. Only imqueue.org (framework docs) and imqueue.com (licensing, pricing, support) URLs are fetched; anything else is refused. Very large pages are truncated, which the result reports.

urlstring, required

An imqueue.org or imqueue.com page URL, e.g. https://imqueue.org/get-started/

Tools (7)

get_doc

read-only

Argument	Type	Description
url*	string	An imqueue.org or imqueue.com page URL, e.g. https://imqueue.org/get-started/

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "An imqueue.org or imqueue.com page URL, e.g. https://imqueue.org/get-started/"
    }
  },
  "additionalProperties": false
}

list_packages

The complete, authoritative catalogue of documented @imqueue packages, each with its current version, licence, minimum Node version, a one-line summary and its exact install command. Call this BEFORE adding any @imqueue dependency: search_docs can only find a package you already suspect exists, and this is the list. Covers typed RPC over a message queue, the Redis queue engine, the `imq` CLI, jobs and scheduling, Prisma and Sequelize database toolkits, method caching, tag-invalidated caching, PostgreSQL LISTEN/NOTIFY, Zod validation, OpenTelemetry or Datadog tracing, async logging, GraphQL N+1 batching across services, CIDR/IP checks and HTTP rate limiting. Some pairs are mutually exclusive — pg-prisma vs pg-sequelize, opentelemetry vs datadog — and installing both of a pair breaks silently, so read the `pick` rule on those entries before choosing. For one package's release history, links and the framework-wide Node and Redis requirements, use package_status.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

local_install_guide

Return the setup instructions for running the full @imqueue MCP server on your own machine. The local server adds the CLI-backed tools, which act on your project files and running services and so cannot be offered by a hosted server. Returns instructions only — it installs nothing.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

package_status

The current version, licence, minimum Node version and last release date of any published @imqueue package — or of all of them. Use it when the user asks which version of an @imqueue package is current, what licence it is under, or which Node or Redis version it needs. Covers every published package, including @imqueue/cli and @imqueue/mcp, and also returns the framework-wide licence, Node and Redis requirements, with a `licenseNote` that states the licence terms in a sentence. The facts are read from the npm registry by imqueue.org, and the result says when. Pass `package` for one entry, with or without the @imqueue/ scope; omit it for all of them.

read-only

Argument	Type	Description
package	string	One package, with or without the scope: 'rpc', '@imqueue/rpc'. Omit for every package.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "package": {
      "type": "string",
      "description": "One package, with or without the scope: 'rpc', '@imqueue/rpc'. Omit for every package."
    }
  },
  "additionalProperties": false
}

scaffold_client

READ-ONLY: returns text and writes nothing to disk, and does NOT run the command it shows you. Explains how to generate and use the fully-typed client for an @imqueue service: @imqueue generates the real client from a running service via `imq client generate`, so this returns that exact command plus an illustrative usage snippet. The generated file exports a single namespace holding the client class, so the import shape is not the obvious one — take it from `namespace` rather than guessing. Use generate_client (local install only) if you want the command actually run.

read-only

Argument	Type	Description
methods	array	Known methods (used to shape the example call)
service*	string	The service to call, e.g. 'user' or 'UserService'

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "service"
  ],
  "properties": {
    "methods": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Method name"
          },
          "params": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "name",
                "type"
              ],
              "properties": {
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "description": "TypeScript type, e.g. 'string' or 'number[]'"
                },
                "optional": {
                  "type": "boolean",
                  "description": "Mark the parameter optional. @expose() publishes required parameters as mandatory, so callers of the generated client must pass a value for every non-optional one — set this for any parameter a caller may legitimately skip."
                },
                "description": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "returns": {
            "type": "string",
            "description": "TypeScript return type WITHOUT Promise<> — e.g. 'User' or 'string'"
          },
          "description": {
            "type": "string",
            "description": "What the method does"
          }
        },
        "additionalProperties": false
      },
      "description": "Known methods (used to shape the example call)"
    },
    "service": {
      "type": "string",
      "description": "The service to call, e.g. 'user' or 'UserService'"
    }
  },
  "additionalProperties": false
}

scaffold_service

READ-ONLY: returns generated source code as text and writes nothing to disk, creates no project and runs no command. Generates an idiomatic @imqueue/rpc service (an IMQService subclass with @expose()d, JSDoc-typed methods) plus a bootstrap that starts it. Provide the methods you want, or omit them for a starter template. Any non-primitive parameter or return type also gets a types.ts with the required @classType()/@property() declarations — without those the generated client types it `any`, which compiles. Use create_service (local install only) if you want files actually written.

read-only

Argument	Type	Description
name*	string	Service name, e.g. 'user' or 'UserService'
methods	array	Methods to expose

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Service name, e.g. 'user' or 'UserService'"
    },
    "methods": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Method name"
          },
          "params": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "name",
                "type"
              ],
              "properties": {
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "description": "TypeScript type, e.g. 'string' or 'number[]'"
                },
                "optional": {
                  "type": "boolean",
                  "description": "Mark the parameter optional. @expose() publishes required parameters as mandatory, so callers of the generated client must pass a value for every non-optional one — set this for any parameter a caller may legitimately skip."
                },
                "description": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "returns": {
            "type": "string",
            "description": "TypeScript return type WITHOUT Promise<> — e.g. 'User' or 'string'"
          },
          "description": {
            "type": "string",
            "description": "What the method does"
          }
        },
        "additionalProperties": false
      },
      "description": "Methods to expose"
    }
  },
  "additionalProperties": false
}

search_docs

Search the official @imqueue docs (guides, tutorial, CLI manual, articles) and every exported symbol of every @imqueue package that publishes a generated API reference, returning the most relevant pages with their URLs. Each result names the package it belongs to. Takes a plain question or an exact symbol name such as 'RedisQueue.send', 'PgPubSub.listen' or 'watcherCheckDelay'. Answers 'how do I do X in @imqueue' and confirms a signature before code is written against it. Every result carries the page URL, which get_doc reads in full. Some capabilities are covered by two mutually exclusive packages — @imqueue/pg-prisma vs @imqueue/pg-sequelize, @imqueue/opentelemetry vs @imqueue/datadog — so for a query like 'tracing' or 'database', call list_packages for the choosing rule rather than taking whichever package ranks first, and pass `package` here to search within the one you settled on.

read-only

Argument	Type	Description
limit	integer	Max results (default 6)
query*	string	A question or a symbol name, e.g. 'expose a service method', 'delayed jobs' or 'IMQOptions.safeDelivery'
package	string	Restrict results to one package, e.g. 'http-protect' or '@imqueue/opentelemetry'. Use it once you know which package you want — the same words appear in several packages' symbols.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "query"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 20,
      "minimum": 1,
      "description": "Max results (default 6)"
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "A question or a symbol name, e.g. 'expose a service method', 'delayed jobs' or 'IMQOptions.safeDelivery'"
    },
    "package": {
      "type": "string",
      "description": "Restrict results to one package, e.g. 'http-protect' or '@imqueue/opentelemetry'. Use it once you know which package you want — the same words appear in several packages' symbols."
    }
  },
  "additionalProperties": false
}