Skip to main content
Glama

delete_doc

Remove a document by moving it to trash, with recovery possible through the Dart web interface.

Instructions

Delete a document (moves to trash - recoverable via Dart web UI)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
doc_idYesDocument doc_id to delete

Implementation Reference

  • Main handler function for the delete_doc tool. Validates input (DART_TOKEN, doc_id), calls DartClient.deleteDoc(), and returns DeleteDocOutput with recoverability information.
    export async function handleDeleteDoc(input: DeleteDocInput): Promise<DeleteDocOutput> {
      const DART_TOKEN = process.env.DART_TOKEN;
    
      if (!DART_TOKEN) {
        throw new DartAPIError(
          'DART_TOKEN environment variable is required. Get your token from: https://app.dartai.com/?settings=account',
          401
        );
      }
    
      // ============================================================================
      // Step 1: Validate input and doc_id
      // ============================================================================
      if (!input || typeof input !== 'object') {
        throw new DartAPIError(
          'input is required and must be an object',
          400
        );
      }
    
      if (!input.doc_id || typeof input.doc_id !== 'string' || input.doc_id.trim() === '') {
        throw new DartAPIError(
          'doc_id is required and must be a non-empty string',
          400
        );
      }
    
      // ============================================================================
      // Step 2: Call DartClient.deleteDoc()
      // ============================================================================
      const client = new DartClient({ token: DART_TOKEN });
    
      let result: { success: boolean; doc_id: string };
      try {
        result = await client.deleteDoc(input.doc_id);
      } catch (error) {
        // Handle 404 errors specifically
        if (error instanceof DartAPIError && error.statusCode === 404) {
          throw new DartAPIError(
            `Document not found: No document with doc_id "${input.doc_id}" exists in workspace`,
            404,
            error.response
          );
        }
        // Re-throw other errors with enhanced context
        if (error instanceof DartAPIError) {
          throw new DartAPIError(
            `Failed to delete document: ${error.message}`,
            error.statusCode,
            error.response
          );
        }
        throw error;
      }
    
      // ============================================================================
      // Step 3: Return output with recoverability information
      // ============================================================================
      return {
        doc_id: result.doc_id,
        deleted: result.success,
        recoverable: true, // Documents move to trash (recoverable via web UI)
        message: `Document "${result.doc_id}" moved to trash. Recoverable via Dart web UI: https://app.dartai.com/trash`,
      };
    }
  • DeleteDocInput interface – defines the input schema with a required doc_id string field.
    export interface DeleteDocInput {
      doc_id: string;
    }
  • DeleteDocOutput interface – defines the output shape with doc_id, deleted, recoverable, and message fields.
    export interface DeleteDocOutput {
      doc_id: string;
      deleted: boolean;
      recoverable: boolean;
      message: string;
    }
  • src/index.ts:762-774 (registration)
    Tool registration in the MCP server tool list – defines the name 'delete_doc', description, and inputSchema (object with required doc_id string).
      name: 'delete_doc',
      description: 'Delete a document (moves to trash - recoverable via Dart web UI)',
      inputSchema: {
        type: 'object',
        properties: {
          doc_id: {
            type: 'string',
            description: 'Document doc_id to delete',
          },
        },
        required: ['doc_id'],
      },
    },
  • src/index.ts:1160-1170 (registration)
    Tool dispatch handler in the main switch statement – calls handleDeleteDoc and returns JSON-formatted result.
    case 'delete_doc': {
      const result = await handleDeleteDoc((args || {}) as any);
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(result, null, 2),
          },
        ],
      };
    }
Behavior3/5

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

The description adds the important behavioral detail that deletion moves the document to trash (recoverable via web UI), which is beyond the schema. However, it lacks information on permissions, idempotency, or error handling, which would be expected for a mutation tool without annotations.

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 that conveys the essential information without waste. The key behavior (move to trash) is front-loaded.

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 simplicity (one parameter, no output schema) and the sibling context, the description is fairly complete. It explains the recovery behavior, which is crucial. Minor gaps include not addressing error cases or concurrency, but overall adequate.

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% with a clear description for the one parameter 'doc_id'. The tool description does not add additional semantic meaning beyond what the schema provides, so baseline 3 is appropriate.

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 action ('Delete') and the resource ('a document'), and adds the specific behavior of moving to trash rather than permanent deletion, distinguishing it from other tools.

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 for deleting documents but does not explicitly state when to use this tool versus alternatives like batch_delete or updating a document to mark it inactive. No exclusions or context are 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/standardbeagle/dart-query'

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