Skip to main content
Glama

deleteDocuments

Remove documents from knowledge bases using filter criteria like document type, source, or status to manage content organization.

Instructions

Permanently deletes documents that match the specified filter criteria.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
namespaceIdNo
documentIdsNo
tenantIdNo
filterConfigYes

Implementation Reference

  • MCP tool handler for 'deleteDocuments': creates SourceSync client, prepares filterConfig with enum conversions, and calls client.deleteDocuments to delete matching documents.
    'deleteDocuments',
    'Permanently deletes documents that match the specified filter criteria.',
    DeleteDocumentsSchema.shape,
    async (params: any) => {
      return safeApiCall(async () => {
        const { namespaceId, documentIds, tenantId, filterConfig } = params
    
        // Create a client with the provided parameters
        const client = createClient({ namespaceId, tenantId })
    
        // Add documentIds to filter if provided and not already in filter
        if (documentIds && documentIds.length > 0 && !filterConfig.documentIds) {
          filterConfig.documentIds = documentIds
        }
    
        // Call the deleteDocuments method with properly structured parameters
        return await client.deleteDocuments({
          filterConfig: {
            ...filterConfig,
            // Convert string enum values to their SourceSync enum equivalents
            documentTypes: filterConfig.documentTypes?.map(
              (type: string) =>
                SourceSyncDocumentType[
                  type as keyof typeof SourceSyncDocumentType
                ],
            ),
            documentIngestionSources: filterConfig.documentIngestionSources?.map(
              (source: string) =>
                SourceSyncIngestionSource[
                  source as keyof typeof SourceSyncIngestionSource
                ],
            ),
            documentIngestionStatuses:
              filterConfig.documentIngestionStatuses?.map(
                (status: string) =>
                  SourceSyncIngestionStatus[
                    status as keyof typeof SourceSyncIngestionStatus
                  ],
              ),
          },
        })
      })
    },
  • Zod schema defining input parameters for the deleteDocuments tool, including optional namespaceId, documentIds, tenantId, and filterConfig.
    export const DeleteDocumentsSchema = z.object({
      namespaceId: namespaceIdSchema.optional(),
      documentIds: z.array(z.string()).optional(),
      tenantId: tenantIdSchema,
      filterConfig: FilterConfigSchema,
    })
  • src/index.ts:478-522 (registration)
    Registration of the 'deleteDocuments' MCP tool with name, description, input schema, and inline handler function.
    server.tool(
      'deleteDocuments',
      'Permanently deletes documents that match the specified filter criteria.',
      DeleteDocumentsSchema.shape,
      async (params: any) => {
        return safeApiCall(async () => {
          const { namespaceId, documentIds, tenantId, filterConfig } = params
    
          // Create a client with the provided parameters
          const client = createClient({ namespaceId, tenantId })
    
          // Add documentIds to filter if provided and not already in filter
          if (documentIds && documentIds.length > 0 && !filterConfig.documentIds) {
            filterConfig.documentIds = documentIds
          }
    
          // Call the deleteDocuments method with properly structured parameters
          return await client.deleteDocuments({
            filterConfig: {
              ...filterConfig,
              // Convert string enum values to their SourceSync enum equivalents
              documentTypes: filterConfig.documentTypes?.map(
                (type: string) =>
                  SourceSyncDocumentType[
                    type as keyof typeof SourceSyncDocumentType
                  ],
              ),
              documentIngestionSources: filterConfig.documentIngestionSources?.map(
                (source: string) =>
                  SourceSyncIngestionSource[
                    source as keyof typeof SourceSyncIngestionSource
                  ],
              ),
              documentIngestionStatuses:
                filterConfig.documentIngestionStatuses?.map(
                  (status: string) =>
                    SourceSyncIngestionStatus[
                      status as keyof typeof SourceSyncIngestionStatus
                    ],
                ),
            },
          })
        })
      },
    )
  • SourceSyncApiClient helper method that sends DELETE request to /v1/documents endpoint with namespaceId and filterConfig to delete matching documents.
    public async deleteDocuments({
      filterConfig,
    }: Omit<
      SourceSyncDeleteDocumentsRequest,
      'namespaceId'
    >): Promise<SourceSyncDeleteDocumentsResponse> {
      return this.client
        .url(`/v1/documents`)
        .json({
          namespaceId: this.namespaceId,
          filterConfig,
        } satisfies SourceSyncDeleteDocumentsRequest)
        .delete()
        .json<SourceSyncDeleteDocumentsResponse>()
    }
Behavior2/5

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

With no annotations provided, the description carries full burden. It discloses the destructive nature ('permanently deletes'), which is critical, but lacks details on permissions required, rate limits, confirmation prompts, error handling, or what happens to associated data. This is a significant gap for a high-impact mutation tool.

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 front-loads the key action ('permanently deletes') and resource. There is no wasted verbiage, making it easy to parse quickly.

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 destructive tool with 4 parameters, 0% schema coverage, no annotations, and no output schema, the description is inadequate. It lacks details on behavioral traits, parameter usage, return values, and error conditions, leaving critical gaps for safe and effective use.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate. It mentions 'filter criteria' which hints at the 'filterConfig' parameter, but doesn't explain the four parameters (namespaceId, documentIds, tenantId, filterConfig) or their relationships. The description adds minimal value beyond the schema's structure.

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 ('permanently deletes') and resource ('documents'), specifying it applies to those matching filter criteria. It distinguishes from siblings like 'updateDocuments' or 'fetchDocuments' by focusing on deletion, but doesn't explicitly contrast with similar destructive tools like 'deleteNamespace'.

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?

No explicit guidance on when to use this tool versus alternatives is provided. The description doesn't mention prerequisites, constraints, or suggest other tools for related operations like 'updateDocuments' for modifications or 'fetchDocuments' for retrieval before deletion.

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/sitegpt/sourcesyncai-mcp'

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