Skip to main content
Glama

query_catalog

Retrieve loaded OSCAL Catalogs with metadata and child type counts; query by UUID or title to locate catalogs and support control and group exploration.

Instructions

Return loaded OSCAL Catalogs with metadata and childTypeCounts. For controls and groups, use list_catalog_controls or list_catalog_groups, then get_child_element.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "query_catalog"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum items per page, 1-100.
offsetNoZero-based index of the first item.
query_typeNo"all" (paged), "by_uuid", or "by_title" (exact, then full-text).all
query_valueNoUUID or title to match. Required for by_uuid and by_title.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.7.1
    • addedInput schema / properties / limit / description
      Added value: +"Maximum items per page, 1-100."
    • addedInput schema / properties / offset / description
      Added value: +"Zero-based index of the first item."
    • addedInput schema / properties / query_type / description
      Added value: +"\"all\" (paged), \"by_uuid\", or \"by_title\" (exact, then full-text)."
    • changedInput schema / properties / query_type / enum
      Previous value: -[
      -  "all",
      -  "by_uuid",
      -  "by_title",
      -  "by_type"
      -]New value: +[
      +  "all",
      +  "by_uuid",
      +  "by_title"
      +]
    • addedInput schema / properties / query_value / description
      Added value: +"UUID or title to match. Required for by_uuid and by_title."
  2. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. The word 'loaded' usefully signals that only already-loaded catalogs are returned (no fetch/expansion), and childTypeCounts is named as a return field. But it says nothing about pagination semantics, how filtering behaves when query_value is omitted, or what an empty result looks like.

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?

Two sentences, front-loaded with the return contract and followed by the routing rule; no filler. The mid-sentence line break is cosmetic only, though the second sentence packs two redirects into one clause.

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

Completeness3/5

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

With no output schema, the description is the only place return shape lives, and it only names 'metadata and childTypeCounts' without structure. For a paged query tool with fully documented params this is workable, but an agent must infer how results are ordered and what happens with query_type='all' vs the filters.

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

Parameters3/5

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

Schema description coverage is 100% and all four parameters (limit, offset, query_type, query_value) are documented in the schema with enum meanings, so baseline 3 applies. The description adds no syntax hints or constraints beyond what the schema already states.

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

Purpose4/5

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

States a specific verb and resource ('Return loaded OSCAL Catalogs') and names the payload fields (metadata and childTypeCounts), which is more than a tautology. It distinguishes itself from the control/group listing siblings, but leaves ambiguity with the sibling `list_catalogs`, which the description never contrasts.

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

Usage Guidelines4/5

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

Explicitly routes the agent away from this tool for child data: 'For controls and groups, use list_catalog_controls or list_catalog_groups, then get_child_element.' That is clear when-not guidance. It stops short of explaining when to pick this over `list_catalogs`, the closest overlapping sibling.

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