Skip to main content
Glama

Get rule source (YAML)

get_rule_source
Read-only

Fetch a domain's rule set as editable YAML, including parsed rules and edit permission, to review before updating.

Instructions

Fetch a domain's rule set as editable YAML (plus the parsed rules and whether you may edit it). Use this before put_rules to see the current rules. For a built-in demo domain you get your own copy's rules once you have edited it, otherwise the shared demo's.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
domainYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.3

TDQS

A3.9/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, and the description adds genuinely useful behavior beyond it: that the return includes parsed rules and an editability flag, and the demo-domain copy semantics. It stops short of describing freshness, size, or error behavior for unknown domains.

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?

Three short sentences, front-loaded with the primary outcome before the usage cue. The final demo-domain sentence is a little convoluted ('your own copy's rules once you have edited it, otherwise the shared demo's') but still earns its place by explaining a non-obvious behavior.

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?

An output schema exists, so return shape need not be spelled out, and the description rightly focuses on behavior and sequencing. Given a single trivial parameter, the only real omission is any hint about valid domain values, which keeps this just short of complete.

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?

There is one required parameter, 'domain', with 0% schema description coverage, so the schema adds nothing and the description must compensate. The description only obliquely implies what a domain is (via the demo-domain sentence) and never clarifies naming format or where to discover valid domains.

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 ('Fetch') and resource ('a domain's rule set as editable YAML') and enumerates what comes back (parsed rules, edit permission). It partially differentiates from siblings by emphasizing editable source YAML, but never explicitly contrasts with list_rules, so an agent must still infer which of the two rule-retrieval tools it wants.

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 sequencing cue: 'Use this before `put_rules` to see the current rules', which clearly names the downstream tool this complements. It lacks any when-not guidance or a named alternative (e.g. list_rules) for read-only inspection.

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