Skip to main content
Glama

Describe collection

describe_collection
Read-onlyIdempotent

Preview exactly which PowerShell scripts, commands, and parameters a pc-diag tool will run before collection, without reading system data—use it to verify what will be gathered or confirm privacy.

Instructions

Before collecting: exactly which PowerShell scripts (full source) and commands a tool would run, plus its parameter schema. Reads nothing from the system. Use it when the user asks what will be gathered or whether it is private.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "tool_name": "<tool_name>"
    },
    "name": "describe_collection"
  }
}

Input Schema

NameRequiredDescriptionDefault
tool_nameYesName of a pc-diag tool.

Output Schema

NameRequiredDescriptionDefault
toolYes
scriptsYes
summaryYes
commandsYes
read_onlyNo
parameters_schemaYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, openWorldHint false, idempotent and non-destructive, so the safety profile is largely pre-supplied; 'Reads nothing from the system' reinforces that but adds only modestly. The genuinely useful additions are that the returned scripts are full source and that this answers privacy questions, but there is no mention of how large the response is or what happens for an unknown tool_name. With annotations carrying most of the load, a 3 fits.

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 short sentences, front-loaded with the 'before collecting' cue and ending on the user-facing use case. Tight and waste-free, though the leading 'Before collecting:' fragment is telegraphic enough to cost a bit of readability.

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 one-parameter, read-only introspection tool with an output schema, this covers everything needed: what is returned, that nothing is read from the system, and the user scenario that triggers it. Return-value structure is left to the output schema, as allowed.

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 coverage is 100% and the single parameter already documents that it expects the name of a pc-diag tool. The description adds a little framing (the schema returned is of the same tool being described) but no format, naming convention, or error semantics beyond the schema. Baseline 3 is appropriate.

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 object – it returns the full PowerShell source and commands a given pc-diag tool would execute, plus that tool's parameter schema – which makes clear this is a preview/meta tool rather than a data gatherer like its siblings. The slightly ambiguous name/parameter pairing (describe_collection takes tool_name) is resolved by the text, but the description never names a sibling to contrast with explicitly.

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?

Gives an explicit trigger – 'Before collecting' and 'Use it when the user asks what will be gathered or whether it is private' – which tells an agent exactly when to reach for it. It stops short of a 5 because it names no exclusions or alternative tools for adjacent questions.

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