DocsMint

refresh_document_index

Queues an asynchronous reindex for a single document when an explicit refresh is needed; check index status first, as routine changes already schedule indexing.

Instructions

Queue an explicit asynchronous reindex for one document; use batch_documents(action=refresh_index) for multiple explicit IDs. Routine content and placement changes already schedule indexing; check get_document_index_status first.

Input Schema

Name	Required	Description	Default
`documentId`	Yes	UUID returned by the corresponding list or read operation.
`workspaceId`	No	Workspace UUID from list_workspace_structure(kind=workspaces). Required for ambiguous creates and structure changes; omit to search all granted scopes.

Output Schema

Name	Required	Description	Default
`documentId`	Yes
`deduplicated`	Yes
`generationId`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv2.0.4Oct 27, 2026

addedInput schema / properties / workspaceId

Added value: +{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Workspace UUID from list_workspace_structure(kind=workspaces). Required for ambiguous creates and structure changes; omit to search all granted scopes.",
+  "format": "uuid",
+  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
+  "type": "string"
+}

Changed2 schema fields changedv0.1.2Sep 28, 2026

addedInput schema / additionalProperties
```
Added value: +false
```

changedInput schema / properties / documentId / description

Previous value: -"UUID of the document to refresh, obtained from search_documents or list_documents and visible in the active scope."New value: +"UUID returned by the corresponding list or read operation."

First observedSep 27, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations cover the safety profile (not read-only, not destructive, not idempotent), and the description adds meaningful behavior beyond them: the operation is asynchronous (queued, not immediate) and is often unnecessary because routine edits auto-schedule indexing. It stops short of saying what happens on duplicate queueing or how completion is observed, which would round out the async story.

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?

Two dense sentences with no filler. The primary action is front-loaded, followed by the sibling routing and the precondition check in descending order of importance.

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

Completeness5/5

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

An output schema exists so return values need no explanation, and both parameters are fully described in the schema. The description fills the remaining gaps an agent needs: async nature, sibling routing, and the prerequisite status check.

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 description coverage is 100%, so both documentId and workspaceId are already documented in the schema. The description only implies the single-document constraint ('one document') without adding format, scoping, or ambiguity-resolution detail. Baseline 3 applies when the schema carries the parameter burden.

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?

States a specific verb and resource ('Queue an explicit asynchronous reindex for one document') with clear scope ('one document'). It also distinguishes itself from the batch sibling that handles multiple IDs, so an agent can route correctly without opening either schema.

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

Usage Guidelines5/5

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

Explicitly names the alternative (batch_documents(action=refresh_index)) and the condition that selects it, then adds two negative conditions: routine content/placement changes already schedule indexing, and get_document_index_status should be checked first. This is an unusually complete when/when-not/alternatives statement.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.