Skip to main content
Glama

check_doc_changes

Detect documentation changes by comparing file timestamps against index metadata. Identify added, modified, or deleted files since the last build and optionally trigger automatic index rebuilds to maintain accurate search results.

Instructions

Check which documentation files have been added, modified, or deleted since the last index build. Compares current file timestamps against the index metadata. Optionally triggers an index rebuild if changes are detected.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
auto_rebuildNoAutomatically rebuild the index if changes are detected (default: false)
Behavior3/5

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

With no annotations provided, the description carries full burden. It successfully discloses the comparison mechanism ('timestamps against index metadata') and mutation capability ('triggers an index rebuild'). However, it fails to describe return values (list of changed files? boolean? count?) or error conditions (e.g., behavior when no index exists), which is critical given the lack of output schema.

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 with zero waste: sentence 1 states purpose, sentence 2 explains implementation mechanism (timestamps), sentence 3 describes optional side effects. Information is front-loaded with the core value proposition (checking file changes) before technical details.

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?

For a single-parameter tool with moderate complexity, the description adequately covers the detection logic and optional rebuild behavior. However, given the absence of both annotations and output schema, it should specify what the tool returns (e.g., change list, diff statistics) to be fully 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?

Input schema has 100% description coverage for the single 'auto_rebuild' parameter. The description adds semantic value by explaining the consequence of enabling this parameter ('triggers an index rebuild if changes are detected'), meeting the baseline expectation for high schema coverage scenarios.

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 uses specific verbs ('Check') with clear resource scope ('documentation files') and temporal context ('since the last index build'). It effectively distinguishes from sibling 'rebuild_index' by emphasizing detection/comparison rather than unconditional rebuilding, and from 'get_doc_file' by focusing on change status rather than content retrieval.

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 context through 'Optionally triggers an index rebuild,' suggesting when to use it (for conditional rebuilding). However, it lacks explicit when-to-use guidance (e.g., 'Use this before rebuilding to verify changes') and does not specify when NOT to use it or prerequisites (e.g., requiring an existing index).

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/epicsagas/alcove'

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