Skip to main content
Glama

Moxie Docs

moxie.propose_doc_removal

Propose deleting a Moxie Docs-tracked documentation file that your change makes irrelevant, as part of YOUR current change. Moxie Docs validates the path and returns it for you to delete in your working branch; Moxie Docs itself does not delete files or open a PR - the deletion happens in your branch, so it lands in the SAME PR as the code. Returns the resolved path to delete. Provide either slug or targetPath.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugNoSlug of the existing generated doc to remove.
reasonNoWhy this doc is no longer relevant.
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.
targetPathNoRepository-relative path of the doc to remove (must be a Moxie Docs-tracked doc). Use instead of slug.
removedSourcePathsNoCode paths being deleted that made this doc irrelevant, for provenance.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / targetPath / description
      Previous value: -"Repository-relative path of the doc to remove (must be a Moxie-tracked doc). Use instead of slug."New value: +"Repository-relative path of the doc to remove (must be a Moxie Docs-tracked doc). Use instead of slug."
  2. Changed1 schema field changed
    • changedInput schema / properties / repository / description
      Previous value: -"Optional owner/name reference like \"acme/app\". Required only when the token is authorized for multiple repos and no default is set."New value: +"The 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."
  3. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Goes well beyond the annotations by resolving the tension with destructiveHint=false: it explicitly explains that the tool only validates the path and returns it, does not delete files or open a PR, and that the actual deletion occurs in the caller's branch so it lands in the same PR. This is exactly the behavioral context an agent needs to act correctly on a mutation-shaped tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the core action and the critical 'what actually happens' clarification, and every sentence carries weight. The repeated 'Moxie Docs itself does not delete files or open a PR' phrasing is slightly verbose but the emphasis is warranted for a removal tool.

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?

There is no output schema, but the description supplies the return value ('the resolved path to delete') and explains the downstream consequence of the call. Combined with the branch/PR semantics, nothing essential for correct invocation is missing.

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 coverage is 100%, so the schema already documents all five parameters, including the 'use instead of slug' note on targetPath. The description's 'Provide either slug or targetPath' lightly reinforces the mutual-exclusivity constraint but adds little beyond structured data, so the baseline 3 applies.

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 verb (propose deleting) and resource (Moxie Docs-tracked doc) and ties it to the caller's current change, which cleanly distinguishes it from the sibling moxie.propose_doc_update and the read-oriented get_* tools. An agent can identify the operation without opening the schema.

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

Usage Guidelines4/5

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

It gives clear context for when to use it: when your change makes a doc irrelevant, as part of your current change, and it specifies slug-or-targetPath as the input choice. It stops short of explicitly naming propose_doc_update as the counterpart alternative or stating when removal is inappropriate, so it is strong but not fully explicit.

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