Skip to main content
Glama

check_section_delete_safe

Evaluate if a documentation section can be safely deleted by checking tutorial-path membership, anchor references, backlinks, and recent edits. Returns a safety verdict and ranked blockers to prevent accidental removal.

Instructions

Composite preflight: is this section safe to delete? Fuses tutorial-path membership, anchor-specific backlinks, transitive doc-level backlinks, and recent-edit recency into a single verdict (safe_to_delete, tutorial_path_blocking, anchor_referenced, backlinks_blocking, recently_edited_blocking) plus up to 5 ranked blockers and a one-line recommended_action. Read-only — never mutates the index.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
repoYes
section_idYesStable section ID, format owner/repo::doc_path::slug#level
transitive_depthNoBacklink BFS depth. Default 3.
recent_edit_daysNoDays within which a recent edit becomes a soft blocker. Default 14.
Behavior4/5

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

The description explicitly states 'Read-only — never mutates the index', which is crucial behavioral information. With no annotations provided, this disclosure helps agents understand safety. The output format is also described, though additional details like required permissions or rate limits are omitted.

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 concise and front-loaded, starting with the core purpose ('Composite preflight') and then detailing components and behavior. Every sentence adds value without fluff.

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

Completeness4/5

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

Given the tool's complexity (multiple checks) and lack of output schema, the description adequately covers the verdict types and blockers. However, it does not mention error conditions, prerequisites (e.g., section must exist), or edge cases, leaving some gaps for an agent.

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 high (75%) with descriptions for section_id, transitive_depth, and recent_edit_days. The tool description adds context about the overall function but does not provide additional parameter-level meaning beyond what the schema already offers.

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 it is a 'composite preflight' to check if a section is safe to delete, listing specific checks (tutorial-path, backlinks, recency) and output fields. This distinct purpose differentiates it from sibling tools that are read-only or analytical.

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?

The description implies usage before attempting to delete a section, but does not explicitly state when to use this tool versus alternatives like get_section_blast_radius or get_backlinks. No exclusions or when-not-to-use guidance is provided.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jgravelle/jdocmunch-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server