Skip to main content
Glama

refresh_documentation

Reload all project documentation from disk to synchronize with external updates, providing AI assistants with current documentation.

Instructions

Reload all project documentation from disk when docs are updated externally.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • src/index.js:291-298 (registration)
    The 'refresh_documentation' tool is registered in the ListToolsRequestSchema handler with its input schema (empty object, no parameters required) and description.
      name: 'refresh_documentation',
      description: 'Reload all project documentation from disk when docs are updated externally.',
      inputSchema: {
        type: 'object',
        properties: {},
        additionalProperties: false
      }
    },
  • The tool handler implementation: calls this.docService.reload() to reload all documentation from disk, then returns a success message with the file count and timestamp.
    case 'refresh_documentation':
      await this.docService.reload();
      const docCount = this.docService.documents.size;
      
      return {
        content: [{
          type: 'text',
          text: `āœ… Documentation refreshed successfully!\n\n**Files indexed:** ${docCount}\n**Last updated:** ${new Date().toLocaleString()}\n\nšŸ’” All manually added files should now be available for search and reading.`
        }]
      };
  • The reload() method in DocumentationService clears the documents map and calls loadDocuments() to re-read all documentation files from disk.
    async reload() {
      this.documents.clear();
      this.lastScanned = null;
      await this.loadDocuments();
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It only states it reloads documentation from disk, but fails to disclose if this is destructive, whether it requires permissions, or what the side effects are (e.g., overwriting in-memory state). This is insufficient for a mutation-like operation.

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 a single, clear sentence that front-loads the action. No unnecessary words, making it highly concise.

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?

With no output schema and no annotations, the description should explain what happens after reload (return value, confirmation). It does not describe the result or whether it's safe to call repeatedly, leaving gaps for the agent.

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

Parameters4/5

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

There are no parameters, so the schema coverage is effectively 100%. The description adds no parameter info, but given zero parameters, the baseline is 4. It could mention that the tool is stateless, but not required.

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 verb 'Reload' and the resource 'all project documentation from disk', with a specific trigger condition. It distinguishes from siblings like add_docset or list_docsets which serve different purposes.

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 when docs are updated externally, but does not explicitly state when not to use or provide alternatives. For such a simple tool, the guidance is minimal but acceptable.

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/afterxleep/doc-bot'

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