Skip to main content
Glama

List qURLs

list_qurls
Read-onlyIdempotent

List qURL resources, paginated and optionally filtered by status, date range, or search text. When to use: discovery — finding qURLs by status (e.g.

Instructions

List qURL resources, paginated and optionally filtered by status, date range, or search text. When to use: discovery — finding qURLs by status (e.g. everything still active), auditing date ranges, or full-text search across descriptions and target URLs (via the q parameter). Filters AND together (e.g. status: 'active' + expires_before: '2026-05-01T00:00:00Z' returns active qURLs about to expire). When NOT to use: use get_qurl instead when you already have a specific resource ID — it returns the same per-resource shape more cheaply and includes the qurls[] per-token detail that list_qurls omits. Use resolve_qurl to actually open access to a target URL. Behavior: read-only and idempotent. An empty data[] with meta.has_more: false means no resource matched the filters (not an error). Pagination is cursor-based: when meta.has_more is true, pass meta.next_cursor as cursor on the next call to fetch the following page. Default page size is 20, configurable via limit up to 100. By default only active qURLs are returned; pass status: 'revoked' to see only revoked qURLs or 'active,revoked' to see both. A past resource expires_at does not change its status; individual access tokens can expire. status: 'expired' is not a valid resource filter. Sort defaults to created_at:desc; override with sort: 'expires_at:asc' etc. Returns: { data: QURL[], meta: { has_more: boolean, next_cursor?: string, page_size?: number, request_id?: string } } — each data[] item is the same stable resource shape returned by get_qurl minus per-token detail. Example: list_qurls({ status: "active", sort: "expires_at:asc", limit: 10 }) returns the 10 active qURLs expiring soonest.

Input Schema

NameRequiredDescriptionDefault
qNoSearch query (searches description and target_url)
sortNoSort field and direction as 'field:direction'. Valid fields: created_at, expires_at. Valid directions: asc, desc (default desc). Example: 'created_at:desc'.
limitNoMaximum number of qURLs to return (default: 20)
cursorNoPagination cursor from a previous response
statusNoFilter by status (comma-separated, e.g. 'active,revoked'). Defaults to 'active' when omitted; pass 'revoked' or 'active,revoked' to override. Only active and revoked are valid resource filters; expired is not accepted.
created_afterNoFilter: created after this date (RFC 3339)
expires_afterNoFilter: expires after this date (RFC 3339)
created_beforeNoFilter: created before this date (RFC 3339)
expires_beforeNoFilter: expires before this date (RFC 3339)

Output Schema

NameRequiredDescriptionDefault
dataYes
metaYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.2.2
    • addedOutput schema / properties / data / items / properties / consumer_access
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "contract_id": {
      +      "type": "string"
      +    },
      +    "mode": {
      +      "type": "string"
      +    },
      +    "version": {
      +      "type": "number"
      +    }
      +  },
      +  "required": [
      +    "mode"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / data / items / properties / crid
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / data / items / properties / private
      Added value: +{
      +  "type": "boolean"
      +}
  2. Changed7 schema fields changedv0.2.1
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / created_after / pattern
      Added value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    • addedInput schema / properties / created_before / pattern
      Added value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    • addedInput schema / properties / expires_after / pattern
      Added value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    • addedInput schema / properties / expires_before / pattern
      Added value: +"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    • changedInput schema / properties / status / description
      Previous value: -"Filter by status (comma-separated, e.g., 'active,revoked')"New value: +"Filter by status (comma-separated, e.g. 'active,revoked'). Defaults to 'active' when omitted; pass 'revoked' or 'active,revoked' to override. Only active and revoked are valid resource filters; expired is not accepted."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "data": {
      +      "items": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "created_at": {
      +            "type": "string"
      +          },
      +          "custom_domain": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "description": {
      +            "type": "string"
      +          },
      +          "expires_at": {
      +            "type": "string"
      +          },
      +          "preserve_host": {
      +            "description": "When true, the original Host header is preserved when proxying via the custom domain. Only meaningful when custom_domain is set; defaults to false on the API side.",
      +            "type": "boolean"
      +          },
      +          "qurl_count": {
      +            "description": "Number of access tokens minted for this resource",
      +            "type": "number"
      +          },
      +          "qurl_site": {
      +            "type": "string"
      +          },
      +          "qurls": {
      +            "items": {
      +              "additionalProperties": {},
      +              "description": "Single access token belonging to a qURL resource",
      +              "properties": {
      +                "access_policy": {
      +                  "additionalProperties": {},
      +                  "description": "Access control policy snapshot for this token",
      +                  "properties": {
      +                    "ai_agent_policy": {
      +                      "additionalProperties": {},
      +                      "properties": {
      +                        "allow_categories": {
      +                          "items": {
      +                            "type": "string"
      +                          },
      +                          "type": "array"
      +                        },
      +                        "block_all": {
      +                          "type": "boolean"
      +                        },
      +                        "deny_categories": {
      +                          "items": {
      +                            "type": "string"
      +                          },
      +                          "type": "array"
      +                        }
      +                      },
      +                      "type": "object"
      +                    },
      +                    "geo_allowlist": {
      +                      "items": {
      +                        "type": "string"
      +                      },
      +                      "type": "array"
      +                    },
      +                    "geo_denylist": {
      +                      "items": {
      +                        "type": "string"
      +                      },
      +                      "type": "array"
      +                    },
      +                    "ip_allowlist": {
      +                      "items": {
      +                        "type": "string"
      +                      },
      +                      "type": "array"
      +                    },
      +                    "ip_denylist": {
      +                      "items": {
      +                        "type": "string"
      +                      },
      +                      "type": "array"
      +                    },
      +                    "user_agent_allow_regex": {
      +                      "type": "string"
      +                    },
      +                    "user_agent_deny_regex": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "created_at": {
      +                  "type": "string"
      +                },
      +                "expires_at": {
      +                  "type": "string"
      +                },
      +                "label": {
      +                  "type": "string"
      +                },
      +                "max_sessions": {
      +                  "type": "number"
      +                },
      +                "one_time_use": {
      +                  "type": "boolean"
      +                },
      +                "qurl_id": {
      +                  "type": "string"
      +                },
      +                "qurl_site": {
      +                  "type": "string"
      +                },
      +                "session_duration": {
      +                  "description": "Seconds of access granted after a successful resolve",
      +                  "type": "number"
      +                },
      +                "status": {
      +                  "default": "unknown",
      +                  "description": "Per-token status (wider than resource status — tokens may be consumed/expired independently)",
      +                  "enum": [
      +                    "active",
      +                    "consumed",
      +                    "expired",
      +                    "revoked",
      +                    "unknown"
      +                  ],
      +                  "type": "string"
      +                },
      +                "use_count": {
      +                  "type": "number"
      +                }
      +              },
      +              "required": [
      +                "qurl_id",
      +                "status"
      +              ],
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "resource_id": {
      +            "description": "Stable resource identifier (public key or legacy r_ ID)",
      +            "type": "string"
      +          },
      +          "slug": {
      +            "description": "Immutable per-owner resource identity, when one was supplied at create time",
      +            "type": "string"
      +          },
      +          "status": {
      +            "default": "unknown",
      +            "enum": [
      +              "active",
      +              "revoked",
      +              "expired",
      +              "unknown"
      +            ],
      +            "type": "string"
      +          },
      +          "tags": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "target_url": {
      +            "description": "Underlying URL the qURL protects; omitted on connector-owned resources",
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "resource_id",
      +          "expires_at",
      +          "created_at",
      +          "status"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "meta": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "has_more": {
      +          "description": "True if more pages are available beyond this response",
      +          "type": "boolean"
      +        },
      +        "next_cursor": {
      +          "description": "Pass to a subsequent list_qurls call to fetch the next page",
      +          "type": "string"
      +        },
      +        "page_size": {
      +          "type": "number"
      +        },
      +        "request_id": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "has_more"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "data",
      +    "meta"
      +  ],
      +  "type": "object"
      +}
  3. First observedv0.2.0

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare read-only/idempotent/non-destructive, and the description adds substantial non-obvious behavior: empty results are not an error, cursor pagination via `meta.next_cursor`, default page size 20 (max 100), default status filter of `active`, and that `expired` is not a valid resource filter.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose and cleanly partitioned into use/not-use/behavior/returns sections, so it scans well. It is long and the 'Returns' block restates the output shape that already exists as an output schema, which is mild redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter list tool with an output schema and full annotations, the description covers filtering semantics, pagination, defaults, sort behavior, and the no-match case. Nothing an agent needs to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description earns above that by explaining that filters AND together (with a worked status+expires_before example) and by clarifying status default/override semantics. Some detail (limit default, status default) still overlaps the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('List qURL resources') and immediately scopes it as paginated with optional filtering. It explicitly distinguishes itself from `get_qurl` and `resolve_qurl`, so an agent can route correctly without opening schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Contains explicit 'When to use' (discovery, auditing, full-text search) and 'When NOT to use' sections naming the preferred alternatives (`get_qurl` for known IDs, `resolve_qurl` to open access). This is the highest tier of routing guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.