Skip to main content
Glama

Moxie Docs

moxie.get_documentation_patterns

Read-onlyIdempotent

Get Moxie's summary of how THIS repository organizes and maintains documentation - where docs live relative to code and how they are kept current. Read-only; no side effects. Returns a Markdown list of pattern entries, each with a title, explanation, and source citations. Use this to decide WHERE a new doc should go before calling propose_doc_update; for the list of WHICH docs need work, use get_documentation_opportunities instead.

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.

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description reinforces with 'Read-only; no side effects.' It also adds useful behavioral detail about the output format (Markdown list with title, explanation, source citations). The description is consistent with annotations and adds context about return shape and usage context. Though it could mention pagination or rate limits, but those are not expected here. This is above baseline since it adds 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?

Three sentences, each purposeful: what it does, output format, and usage guidance. No fluff, front-loaded with the core purpose, then output detail, then usage guidance. No wasted words.

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?

For a simple read-only tool with one optional parameter and no output schema, the description covers the purpose, output format, usage context, and distinguishes from siblings. Combined with rich annotations (readOnly, idempotent, non-destructive), it leaves no gaps. The description also explains the fallback behavior of the parameter when omitted, which is helpful for multi-repo tokens.

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?

The single parameter `repository` is fully documented in the schema (100% coverage) with format, case-insensitivity, and fallback behavior when omitted for multi-repo tokens. The description adds the purpose of the parameter contextually (decision-making about docs), but the schema already covers semantics. Since coverage is 100%, baseline is 3, and the description slightly enhances by tying the parameter to the tool's purpose, so 4 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 clearly states the tool returns a summary of how the repository organizes and maintains documentation, with a specific output format (Markdown list with title, explanation, source citations). It also distinguishes itself from siblings by naming get_documentation_opportunities as the alternative for knowing which docs need work.

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?

Explicitly states when to use this tool (to decide WHERE a new doc should go) and when not to, pointing to get_documentation_opportunities for the list of which docs need work, and propose_doc_update as the subsequent step. This provides clear decision guidance.

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