Skip to main content
Glama

moxie.get_documentation_opportunities

Read-onlyIdempotent

List the actionable documentation updates Moxie Docs recommends as a prioritized queue: missing docs, drift repairs, and PR-template work. Read-only; no side effects. Returns a Markdown list, each opportunity with a title, kind (documentation_gap | documentation_drift | pr_template), severity, summary, suggested action, estimated files changed, and source paths. Use this to pick the next doc task; it is the superset of get_doc_gaps (which lists gaps only).

Input Schema

NameRequiredDescriptionDefault
kindNoOptional kind filter: documentation_gap, documentation_drift, or pr_template.
severityNoOptional severity filter: high, medium, low, or info.
repositoryNoThe target repository as "owner/name" (e.g. "acme/app"). Always pass this unless your token is scoped to a single repository. Matching is case-insensitive. If omitted when the token serves multiple repos, the call returns the list of repositories to choose from instead of an answer.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotent/non-destructive, so 'Read-only; no side effects' is largely redundant; the value-add is the disclosed return shape – a Markdown list with title, kind, severity, summary, suggested action, estimated files changed, and source paths. It does not mention auth scope or rate limits, but the safety profile is fully covered elsewhere.

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?

Front-loads what the tool returns, follows with the safety note, then the return structure, then the routing guidance. Every sentence carries distinct information; 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 compensates by enumerating the returned fields in order. Combined with the read-only disclosure and sibling routing, an agent has everything needed to select and invoke it correctly.

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 kind, severity and repository are fully documented in the schema, including the important repository fallback behavior. The description adds no extra parameter semantics (e.g., filter combination rules), so baseline 3 applies.

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 and resource ('List the actionable documentation updates Moxie Docs recommends as a prioritized queue') and enumerates the three content kinds it covers. It explicitly positions itself against the sibling get_doc_gaps ('the superset of get_doc_gaps'), so an agent can disambiguate without opening a schema.

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?

Gives a direct usage directive ('Use this to pick the next doc task') and names the alternative plus the condition that separates them (get_doc_gaps 'lists gaps only'). The superset framing tells the agent when this tool is the right choice over the narrower sibling.

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.