Skip to main content
Glama

merjax_propose_doc_update

Manual trigger for the AI doc-update flow: scans tracked sections on the default branch and opens a PR rewriting stale prose. Requires 'repo' scope.

Input Schema

NameRequiredDescriptionDefault
repoYes
ownerYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior4/5

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

Annotations only say readOnlyHint=false and destructiveHint=false; the description goes further by disclosing the side effect (a PR is opened, not a direct commit to the default branch) and the required 'repo' scope for authorization. It stays consistent with the annotations since opening a PR is a non-destructive write. It does not say whether repeated invocations create duplicate PRs or what happens when nothing is stale.

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 sentences, both front-loaded with the trigger, target, and effect; the authorization requirement is appended last without interrupting the main idea. No filler or redundant restatement of the tool name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter mutation with no output schema and only generic annotations, the description covers trigger, target branch, effect, and auth scope. It still leaves an agent guessing about the response (PR URL/number?), about what 'tracked sections' means or how they are configured, and about cost or idempotency of the AI rewrite pass.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry owner/repo meaning, but it only mentions a 'repo' scope requirement and never explains what owner and repo designate. It implicitly establishes that the operation targets the given repository's default branch, but adds no format, defaulting, or constraint information beyond the parameter names.

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 action (manual trigger of the AI doc-update flow), the exact mechanism (scans tracked sections on the default branch) and the concrete output (opens a PR rewriting stale prose). This is clearly separable from siblings like merjax_create_pr or merjax_apply_patch, which neither scan tracked doc sections nor generate prose rewrites.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

"Manual trigger" implies it is the on-demand counterpart to some automatic flow, which gives implicit usage context. However, it never states preconditions (e.g., that sections must be tracked/enabled), when not to use it, or which sibling to prefer for related doc work such as merjax_write_file or merjax_apply_patch.

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.

Resources