Skip to main content
Glama

disable_doc

Stop web crawlers from indexing a specific document by disabling its crawling functionality.

Instructions

Disable crawling for a specific doc

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesName of the doc to disable

Implementation Reference

  • The handler logic for the 'disable_doc' tool. It takes the doc name from arguments, sets docConfig[name] = false to disable it, saves the config to file, and returns a success message.
    case "disable_doc": {
      const name = String(request.params.arguments?.name);
      docConfig[name] = false;
      await saveDocConfig();
      return {
        content: [{
          type: "text",
          text: `Disabled doc ${name}`
        }]
      };
    }
  • src/index.ts:422-434 (registration)
    The tool registration and schema definition for 'disable_doc' in the listTools response, specifying name, description, and input schema requiring a 'name' string.
      name: "disable_doc",
      description: "Disable crawling for a specific doc",
      inputSchema: {
        type: "object",
        properties: {
          name: {
            type: "string",
            description: "Name of the doc to disable"
          }
        },
        required: ["name"]
      }
    },
  • The saveDocConfig helper function called by disable_doc handler to persist the updated docConfig to docs-config.json file.
    async function saveDocConfig(): Promise<void> {
      try {
        const config = {
          enabledDocs: docConfig,
          crawledDocs: {}
        };
        if (await fs.pathExists(configPath)) {
          const existingConfig = await fs.readJson(configPath);
          config.crawledDocs = existingConfig.crawledDocs || {};
        }
        await fs.ensureDir(docDir);
        await fs.writeJson(configPath, config, { spaces: 2 });
      } catch (error) {
        console.error('Failed to save doc config:', error);
      }
    }
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. While 'Disable crawling' implies a mutation operation, it doesn't specify whether this change is reversible, what permissions are required, whether it affects existing indexed data, or what happens after disabling. For a mutation tool with zero annotation coverage, this is inadequate.

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, efficient sentence with zero wasted words. It's appropriately sized for a simple tool and gets straight to the point without unnecessary elaboration.

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

Completeness2/5

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

For a mutation tool with no annotations and no output schema, the description is insufficient. It doesn't explain what 'disable crawling' means operationally, what the expected outcome is, or how this interacts with sibling tools. Given the tool's potential impact on system behavior, more context is needed.

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?

The schema description coverage is 100%, with the single parameter 'name' fully documented in the schema. The description doesn't add any parameter semantics beyond what's already in the schema (which specifies 'Name of the doc to disable'). This meets the baseline expectation when schema coverage is complete.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Disable crawling') and the target resource ('for a specific doc'), providing a specific verb+resource combination. However, it doesn't explicitly differentiate from its sibling 'enable_doc' beyond the obvious action difference, missing an opportunity to clarify the relationship between these complementary tools.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'enable_doc' or 'crawl_docs', nor does it mention prerequisites (e.g., whether the doc must be currently enabled). It simply states what the tool does without contextual usage information.

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/askme765cs/open-docs-mcp'

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