Skip to main content
Glama

ruleset_from_style_guide

Read-only

PRO — Turn a prose API style guide into an owned, grounded ruleset: one rule per checkable statement, each validated, with the statements no rule can check listed separately. Test the result with test_ruleset.

Input Schema

NameRequiredDescriptionDefault
guideYesThe API style guide as prose or Markdown (up to 40 KB).
contextNoOptional: why you are asking. One sentence — the task you are trying to complete, or what you expect to get back. Never included in the answer and never used to rank; it is read only when a result turns out to be wrong, which is when knowing the intent is what makes the report actionable.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the description adds meaningful context by describing the transformation output: rules are generated per checkable statement, each is validated internally, and uncheckable statements are listed separately. It does not explain what 'validated' means operationally or whether the ruleset is persisted, but it goes well beyond the annotations.

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?

The description is two sentences, front-loaded with the core action and followed by the verification step. The 'PRO —' prefix is a minor tag but does not obscure meaning, and every sentence contributes useful information.

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 no-output-schema tool, the description sufficiently conveys the return shape: a ruleset with one rule per checkable statement, validation status, and a separate list of uncheckable statements. It stops short of specifying the ruleset format or structure, which an agent may need for downstream processing, but the core behavior is covered.

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%, and the description adds no parameter-level detail beyond the schema. The guide input matches the existing schema description ('prose or Markdown, up to 40 KB'), and the optional context parameter is fully documented in the schema, so baseline 3 is appropriate.

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 states a specific verb and resource: 'Turn a prose API style guide into an owned, grounded ruleset'. It further specifies the output granularity ('one rule per checkable statement') and explicitly separates uncheckable statements, making the transformation distinct from sibling tools like validate_ruleset or document_ruleset.

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?

It provides a clear next step: 'Test the result with test_ruleset', which routes the agent to the right sibling after invocation. However, it does not explicitly state when to use this tool versus validate_ruleset, document_ruleset, or apply_overlay, leaving some ambiguity about preconditions and alternatives.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources