Skip to main content
Glama

moxie.get_documentation_opportunities

Read-onlyIdempotent

List the actionable documentation updates Moxie 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

TableJSON 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.

TDQS

A4.6/5.0
Behavior4/5

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

The description states 'Read-only; no side effects,' which aligns with and reinforces the annotations (readOnlyHint=true, destructiveHint=false, idempotentHint=true). It also discloses the return format (Markdown list) and the detailed composition of the items. The behavior around repository scope (returning list of repositories when omitted and token is multi-repo) is disclosed in the repository parameter description, not in the main body, but the main description conveys the core no-side-effect trait.

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 tightly-scoped sentences. The first states purpose and behavior; the second gives the return composition, usage guidance, and sibling distinction. No filler or redundancy.

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?

Given that there is no output schema, the description compensates by listing the fields of the returned Markdown items (title, kind, severity, summary, suggested action, estimated files changed, source paths). It is not missing critical behavioral details for a read-only listing tool. Slight gap: it does not explicitly state that results are returned in priority order despite calling it a 'prioritized queue' in the first clause, but this is fairly clearly implied.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% — all three parameters (kind, severity, repository) have descriptions in the schema. The description adds the crucial behavioral context for the repository parameter: 'If omitted when the token serves multiple repos, the call returns the list of repositories to choose from instead of an answer.' This meaningfully goes beyond a simple schema definition.

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 clearly states it lists actionable documentation updates in a prioritized queue: missing docs, drift repairs, and PR-template work. It distinguishes itself from sibling get_doc_gaps by explicitly naming it as a subset ('it is the superset of get_doc_gaps').

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?

The description explicitly says 'Use this to pick the next doc task' and identifies the alternative tool to use instead for gaps-only ('get_doc_gaps'). This provides clear when-to-use guidance and names the sibling alternative.

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.

TDQS

A4.4/5.0
Disambiguation4/5

Most tools have clearly distinct purposes, but there is some overlap among the documentation-intelligence getters (get_doc_gaps vs get_documentation_opportunities vs get_doc_impact vs get_documentation_patterns). The descriptions do a good job differentiating them, and the scoping differences are explicit.

Naming Consistency5/5

All tools follow a consistent verb_noun snake_case pattern: get_* for read-only context, propose_* for doc changes, plus list_docs, search_docs, and review_change. The naming is uniform and predictable.

Tool Count5/5

12 tools is well within the ideal 3-15 range and each tool covers a distinct aspect of the documentation workflow. The count feels comprehensive without being bloated.

Completeness4/5

The set covers the core lifecycle: discovering docs, gaps, opportunities, patterns, proposing updates/removals, and reviewing changes. A minor gap is the lack of a tool to fetch the full content of an existing doc (list_docs gives metadata, search_docs returns snippets), but this can be worked around.