DocsMint

get_document_index_status

Read-onlyIdempotent

Check a document's current indexing and pipeline status by ID without starting work; trigger refresh only for an intentional retry.

Instructions

Read current indexing and pipeline status for one document without starting work. Use refresh_document_index only when an explicit retry is intended.

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
`pipeline`	Yes
`documentId`	Yes
`searchable`	Yes
`embeddingStatus`	Yes
`embeddingProfile`	Yes
`activeGenerationId`	Yes
`embeddingErrorCode`	Yes
`embeddingUpdatedAt`	Yes
`pendingGenerationId`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed11 schema fields 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"
+}

removedOutput schema / properties / activeGenerationId / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / properties / activeGenerationId / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / embeddingErrorCode / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / properties / embeddingErrorCode / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / embeddingProfile / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / properties / embeddingProfile / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / embeddingUpdatedAt / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / properties / embeddingUpdatedAt / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / pendingGenerationId / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

addedOutput schema / properties / pendingGenerationId / type
```
Added value: +[
+  "string",
+  "null"
+]
```

Changed2 schema fields changedv0.1.2Sep 28, 2026

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

changedInput schema / properties / documentId / description

Previous value: -"UUID of a document returned by search_documents or list_documents; it must be readable 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 already declare readOnlyHint, idempotentHint, non-destructive, and closed-world behavior, so the safety profile is covered. The description adds a meaningful behavioral detail beyond annotations: this read does not start indexing work, which is precisely why it differs from refresh_document_index. It does not discuss rate limits or workspace scoping, but the essential non-mutating nature is made explicit.

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 definition is two tight sentences with zero waste. The core purpose is front-loaded, and the alternative-use warning follows immediately in a compact routing sentence.

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?

For a simple status-read tool, the description covers purpose, behavioral distinction from the retry sibling, and the fact that no work is started. The output schema exists, annotations already declare the safety profile, and parameter descriptions are fully covered by the schema, leaving no material gap for an agent to call this correctly.

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%, including clear descriptions for documentId and workspaceId, so the schema already carries parameter semantics. The description only implies that status is scoped to one document and does not add syntax, format, or workspace-scope guidance beyond what is already in the schema. Baseline 3 is appropriate when structured fields do the heavy lifting.

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 states a specific verb + resource: 'Read current indexing and pipeline status for one document.' It also distinguishes the tool from the sibling refresh_document_index by clarifying that this tool does not start work. An agent can tell exactly what this tool does and what it is not for.

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?

It explicitly routes the agent to refresh_document_index only when an explicit retry is intended, which is a clear alternative-use condition. The phrase 'without starting work' also clarifies when this read-only status check is appropriate instead of initiating a retry. Nothing material is left to inference.

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