Skip to main content
Glama

Bug class playbook

get_category_guide
Read-onlyIdempotent

Retrieve a bug-class playbook with impact, testing steps, fixes, references, archive severity stats, and real report examples to guide vulnerability research and remediation.

Instructions

A playbook for one bug class: what it is, impact, where to look, how to test, how to fix, references — plus what the archive shows (severity mix, common weaknesses, programs, bounties) and the most instructive real reports as examples.

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": {
      "category": "<category>"
    },
    "name": "get_category_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
categoryYesCategory id or name, e.g. "ssrf", "idor", "request-smuggling", "XSS". See list_categories.
examplesNoHow many example reports to include (default 6).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds real value beyond that by previewing the returned content in detail (severity mix, common weaknesses, programs, bounties, example reports), which matters because there is no output schema.

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?

A single dense sentence, front-loaded with the core identity ('A playbook for one bug class') followed by an em-dash enumeration of contents. Nothing is redundant, though the long compound list is slightly harder to scan than a short structured breakdown would be.

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 read-only, two-parameter lookup with no output schema, the description covers what an agent needs: what the tool returns and that real reports are included. Minor gaps remain — unknown-category behavior and what examples=0 yields are unstated — but they are not blocking.

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%, so both parameters (category id/name, examples count with default and 0-20 bounds) are already fully documented. The description's mention of 'the most instructive real reports as examples' loosely maps to the examples parameter but adds no format or behavior detail beyond the schema. Baseline 3 applies.

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?

The description states a specific resource (a playbook for one bug class) and enumerates its sections: definition, impact, where to look, testing, fixing, references. That is far more concrete than a restatement of the title. It does not explicitly differentiate itself from siblings like get_report or search_reports, which keeps it out of 5 territory.

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

Usage Guidelines3/5

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

Usage is only implied — the 'playbook' framing suggests a knowledge-lookup step before hunting or reporting, but the description never says when to reach for this versus search_reports or get_report. The only routing hint ('See list_categories') lives in the schema, not the description, so it cannot be credited here.

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