Skip to main content
Glama

Export your rules as markdown

export_rules_markdown
Read-only

Return your OTP rules (OOS claims + matched best practices) rendered as a single markdown document, ready to save wherever your agents read their startup context. This tool only returns the text; it does not write to disk. Requires API key.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "export_rules_markdown"
  }
}

Input Schema

NameRequiredDescriptionDefault
output_pathNoOptional path to echo back in the response as the suggested destination. Nothing is written to disk (default: ~/.claude/otp-rules.md)
include_best_practicesNoInclude matched best practices (default true)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare read-only/non-destructive/local behavior, but the description usefully pre-empts a likely misread of the output_path parameter by stating twice that nothing is written to disk. It also discloses the API-key requirement, which annotations do not cover. It stops short of describing document structure or size.

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 short sentences, front-loaded with the output artifact and followed by the two constraints an agent most needs (no disk write, auth required). No filler.

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?

With no output schema, the description carries the return-value burden and does so: it names the document's contents and format. Combined with annotations covering safety, the auth note, and a fully described schema, nothing needed to call this correctly is missing.

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 coverage is 100% and both parameters are fully documented there, including the default path and default true for best practices. The description adds no per-parameter meaning beyond the global 'nothing written to disk' reassurance, so 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?

States a specific verb and resource: return OTP rules (OOS claims + matched best practices) rendered as one markdown document. The 'rendered as markdown' framing distinguishes it from raw-rule siblings like get_my_rules, but it never names that alternative explicitly.

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?

'Ready to save wherever your agents read their startup context' implies the export/bootstrap use case, but there is no explicit when-to-use vs get_my_rules or get_best_practices, and no exclusions. Usage must be inferred from the context hint.

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