Skip to main content
Glama

Moxie Docs

by io.github.Jackalope-Dev

moxie.get_ai_context

Read-onlyIdempotent

Get the compact briefing an agent should read before editing this repository: index status, verified commands, agent tips, top conventions, open documentation gaps, and queued documentation opportunities. Read-only; no side effects. Returns a single Markdown document. Call this first at the start of a task; once you know which files you'll change, follow up with get_doc_impact for path-scoped guidance.

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

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

Annotations already declare readOnly and idempotent hints; the description reinforces 'Read-only; no side effects.' It adds value by stating the return format ('Returns a single Markdown document') and the special behavior when the repository parameter is omitted (returns list of repos). No contradiction exists.

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?

Four concise sentences: purpose, behavior, output, and usage guidance. Front-loaded with the most important information, each sentence contributes new information without redundancy.

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?

Despite having no output schema, the description adequately explains the return type (Markdown document) and the content scope. It covers edge cases (omitted parameter, multi-repo tokens) and provides a clear workflow with sibling tool. For a low-complexity read-only tool, this is complete.

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% and thoroughly explains the repository parameter including format, case-insensitivity, and omitted behavior. The description adds no extra parameter semantics beyond what the schema provides, so baseline 3 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's purpose: 'Get the compact briefing an agent should read before editing this repository' and enumerates the contents. It distinguishes itself from siblings by aggregating multiple categories (index status, commands, tips, conventions, gaps, opportunities) and explicitly names a follow-up tool (get_doc_impact).

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 instructs 'Call this first at the start of a task' and provides a conditional follow-up: 'once you know which files you'll change, follow up with get_doc_impact for path-scoped guidance.' This clearly answers when to use this tool versus alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Moxie Docs toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

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.

Resources