Skip to main content
Glama

Moxie Docs

moxie.review_change

Read-onlyIdempotent

Self-review a change you are about to commit BEFORE opening the PR. Pass the proposed new state of each changed file (and any deleted paths); Moxie returns a severity-ranked list of violations to fix: convention breaches, docs your change makes factually false, net-new API/surface added without docs, and doc references broken by deletions. Read-only; no side effects and no writes. Returns a Markdown verdict (clean | warnings | must-fix) with each finding's location, fix, and - for doc issues - the slug to pass to propose_doc_update. Call this as the final step of the edit flow, then fix findings and re-run.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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.
changedFilesYesThe files your change adds or modifies, in their PROPOSED new state. Provide newContent (the full new file text) for each; you may also/instead provide patch (a unified diff). Max 20 files per call.
deletedPathsNoRepository-relative paths your change DELETES, so Moxie can flag docs whose references break.

TDQS

A4.7/5.0
Behavior5/5

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

The description explicitly states 'Read-only; no side effects and no writes,' which aligns with annotations (readOnlyHint, destructiveHint, idempotentHint). It further discloses what the tool checks (convention breaches, docs made false, net-new API without docs, broken refs) and the output format (Markdown verdict with locations, fixes, and slugs), adding value 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 a single dense paragraph that front-loads the purpose and usage. It efficiently covers what it does, what output to expect, and how to proceed. Every sentence adds value without redundancy, achieving conciseness despite the tool's complexity.

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?

The description fully explains the tool's behavior, inputs, outputs, and usage context. It details the categories of violations, the Markdown verdict format, and the workflow. No output schema exists, but the description compensates by describing the return structure, making the tool comprehensible and actionable.

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 the parameters are well-documented in the schema itself. The description restates 'Pass the proposed new state of each changed file' and mentions 'deleted paths,' but does not add semantic details beyond what the schema already provides (e.g., newContent vs patch, max 20 files). Per the rubric, with high schema coverage, baseline is 3.

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 the verb ('Self-review a change') and specific resource ('about to commit BEFORE opening the PR'). It distinguishes from siblings by explaining it returns a severity-ranked list of violations and explicitly mentions propose_doc_update for doc issues, making it distinct from read-only retrieval tools like get_conventions or 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 gives explicit timing guidance: 'BEFORE opening the PR' and 'Call this as the final step of the edit flow, then fix findings and re-run.' It also implies the workflow by noting that doc issues produce a slug for propose_doc_update, indirectly indicating that tool for follow-up. This is clear when-to-use and provides an alternative path.

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.5/5.0
Disambiguation4/5

Tools are mostly distinct by scope and intent, but get_doc_gaps overlaps with get_documentation_opportunities as a subset, and get_ai_context partially overlaps with conventions and gaps. The descriptions explicitly clarify these relationships, so an agent can usually pick correctly.

Naming Consistency5/5

All tools use a clear verb-prefixed snake_case pattern: get_, list_, propose_, review_, and search_. The naming is uniform and predictable across the entire set.

Tool Count5/5

12 tools is well within the ideal range for a documentation-assistant server. Each tool covers a distinct aspect of the workflow: discovery, context, targeted impact, proposals, and review.

Completeness5/5

The surface covers the full docs workflow: browse and search docs, retrieve conventions/gaps/opportunities, get location guidance, propose updates/removals, and review changes before commit. There are no obvious dead ends for the server's stated purpose.

Resources