Skip to main content
Glama

get_ruleset

Retrieve a specific ruleset and its complete rule definitions, including expressions, actions, and configurations, to inspect which traffic patterns it matches.

Instructions

Get a specific ruleset with all its rules. Returns the complete rule definitions including expressions, actions, and configurations. Useful for inspecting what traffic patterns are matched by a ruleset.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
zone_idYesrequired,The ID of the zone
ruleset_idYesrequired,The ID of the ruleset

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

No annotations are provided, so the description carries the behavioral disclosure burden. It clearly states the output includes complete rule definitions with expressions, actions, and configurations, which is meaningful context beyond the tool name alone. It does not cover error cases or auth requirements, but for a read-only get operation the disclosed behavior is substantial.

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

Conciseness5/5

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

Three sentences, all informative: the first states what the tool does, the second details the return payload, and the third gives the use case. There is no filler, and the naming is front-loaded.

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 tool with only two required parameters, full schema coverage, and no output schema, the description sufficiently explains both the return contents and the practical use case. An agent has enough information to call this tool correctly and interpret the result.

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 the parameters zone_id and ruleset_id are already fully documented in the schema. The description adds no additional parameter-level meaning beyond reinforcing that a specific ruleset is being retrieved.

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?

The description uses a specific verb and resource: 'Get a specific ruleset with all its rules.' It further defines the scope as 'complete rule definitions including expressions, actions, and configurations,' making it clearly distinct from list-oriented siblings like list_rulesets.

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?

The description gives a clear intended use case: 'Useful for inspecting what traffic patterns are matched by a ruleset.' It does not explicitly name alternatives or state when not to use this tool, so it stops short of a 5.

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