Skip to main content
Glama

Read a URL user rule

get_user_rule
Read-only

Read a user rule's accepted MDC, revision, and up to 20 cached versions before refresh, enable/disable, rollback, or deletion; never fetches URLs.

Instructions

Read a user: rule's accepted MDC, revision and up to 20 cached versions.

Read before refresh, enable/disable, rollback or deletion. Never fetches a URL.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rule_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv26.10.16

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already cover safety (readOnlyHint=true, openWorldHint=false), and the description adds genuine value: it clarifies no network fetch occurs and discloses a concrete retrieval cap (up to 20 cached versions), which signals possible truncation. It doesn't discuss auth or error behavior, so not a full 5.

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?

Two short, front-loaded sentences with no filler. The scope statement comes first and the boundary constraint second; every clause earns its place.

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-value explanation is not required, yet the description still summarizes returned content (MDC, revision, cached versions). The main residual gap is that rule_id semantics are left entirely undocumented in both schema and description.

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?

The single parameter rule_id has 0% schema description coverage, so the description must compensate. It hints at rule naming via 'user:<name>' but never explains what a rule_id is, its format, or how it relates to the name — partial compensation only.

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?

States a specific verb (Read) and resource (user:<name> rule) and enumerates what is returned: accepted MDC, revision, and up to 20 cached versions. This distinguishes it clearly from siblings like list_user_rules, refresh_user_rule, and delete_user_rule.

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

Usage Guidelines5/5

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

Explicit when-to-use: 'Read before refresh, enable/disable, rollback or deletion', which names the exact sibling operations that should be preceded by this call. It also states a negative boundary ('Never fetches a URL'), removing an obvious mis-inference given the URL-rule subject matter.

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