Skip to main content
Glama

category_list

Read-only

List categories with extId, key, value, and description to inspect Prism Central metadata, with optional limit and target for scoped reads.

Instructions

[READ] List categories (extId, key, value, description).

Args:
    limit: Max rows to return (default 500). The result reports
        `returned`, `limit`, and `truncated` so a capped read is visible.
    target: Prism Central target name from config; omit for the default.

Input Schema

NameRequiredDescriptionDefault
limitNo
targetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations declare readOnlyHint=true, and the description adds genuinely new behavioral context: a default cap of 500 rows and the fact that the result self-reports `returned`, `limit`, and `truncated` so silent truncation is visible. That truncation disclosure is exactly the kind of trait annotations cannot express, though permissions and error behavior remain unstated.

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?

The read-only marker and purpose are front-loaded in the first sentence, followed by a tight two-item args block. Every line earns its place; only the literal 'Args:'/'limit:'/'target:' scaffolding feels slightly docstring-mechanical.

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

Completeness4/5

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

For a 2-param, read-only list tool with no output schema and no required params, the description covers both parameters and the truncation behavior an agent needs to interpret results correctly. Filtering/sorting options and permission requirements are absent, but nothing essential to calling it 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 description coverage is 0%, so the description must carry the load and largely does: `limit` is defined as max rows with a 500 default, and `target` is explained as a Prism Central target name from config that can be omitted for the default. Neither param's type/format edge cases (e.g. what happens if limit exceeds the available rows) are covered, keeping it short of a 5.

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+resource ('List categories') and even enumerates the returned fields (extId, key, value, description), so the agent knows exactly what comes back. It does not explicitly distinguish itself from sibling category_create/category_assign, but the read-vs-write split is obvious from the name and the '[READ]' tag.

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

Usage Guidelines2/5

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

Nothing states when to prefer this over category_create or category_assign, or whether any prerequisite exists. The only usage-flavored text is 'omit for the default' on the target arg, which is parameter guidance rather than tool-selection guidance.

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