Returns the state of an owned, single-use upload request: awaiting upload, uploading, complete or expired. A completed upload includes its private document ID, SHA-256, page count, byte count and authenticated preview URL. Read-only; does not change the request or the document.
| Name | Required | Description | Default |
|---|---|---|---|
| documentRequestId | Yes |
Changes observed during successful MCP inspections.
Output schema / (root)Previous value: -{
- "$schema": "https://json-schema.org/draft/2020-12/schema",
- "anyOf": [
- {
- "additionalProperties": false,
- "properties": {
- "document": {
- "additionalProperties": false,
- "properties": {
- "bytes": {
- "maximum": 10485760,
- "minimum": 1,
- "type": "integer"
- },
- "contentType": {
- "const": "application/pdf"
- },
- "id": {
- "minLength": 1,
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "pages": {
- "maximum": 50,
- "minimum": 1,
- "type": "integer"
- },
- "previewUrl": {
- "format": "uri-reference",
- "type": "string"
- },
- "sha256": {
- "pattern": "^[a-f0-9]{64}$",
- "type": "string"
- }
- },
- "required": [
- "id",
- "name",
- "pages",
- "bytes",
- "sha256",
- "previewUrl",
- "contentType"
- ],
- "type": "object"
- },
- "documentRequestId": {
- "minLength": 1,
- "type": "string"
- },
- "expiresAt": {
- "type": "string"
- },
- "filename": {
- "type": [
- "string",
- "null"
- ]
- },
- "service": {
- "description": "Current or historical service identifier; reads do not enable new orders.",
- "type": "string"
- },
- "status": {
- "enum": [
- "awaiting_upload",
- "uploading",
- "complete",
- "expired"
- ]
- }
- },
- "required": [
- "documentRequestId",
- "service",
- "filename",
- "status",
- "expiresAt"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "error": {
- "additionalProperties": false,
- "properties": {
- "code": {
- "minLength": 1,
- "type": "string"
- },
- "details": {
- "additionalProperties": false,
- "properties": {
- "addressRole": {
- "enum": [
- "recipient",
- "sender"
- ]
- },
- "canSendAsEntered": {
- "type": "boolean"
- }
- },
- "required": [
- "addressRole",
- "canSendAsEntered"
- ],
- "type": "object"
- },
- "message": {
- "type": "string"
- }
- },
- "required": [
- "code",
- "message"
- ],
- "type": "object"
- }
- },
- "required": [
- "error"
- ],
- "type": "object"
- }
- ],
- "type": "object"
-}New value: +nullOutput schema / (root)Previous value: -nullNew value: +{
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "document": {
+ "additionalProperties": false,
+ "properties": {
+ "bytes": {
+ "maximum": 10485760,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "contentType": {
+ "const": "application/pdf"
+ },
+ "id": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "pages": {
+ "maximum": 50,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "previewUrl": {
+ "format": "uri-reference",
+ "type": "string"
+ },
+ "sha256": {
+ "pattern": "^[a-f0-9]{64}$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "pages",
+ "bytes",
+ "sha256",
+ "previewUrl",
+ "contentType"
+ ],
+ "type": "object"
+ },
+ "documentRequestId": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "expiresAt": {
+ "type": "string"
+ },
+ "filename": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "service": {
+ "description": "Current or historical service identifier; reads do not enable new orders.",
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "awaiting_upload",
+ "uploading",
+ "complete",
+ "expired"
+ ]
+ }
+ },
+ "required": [
+ "documentRequestId",
+ "service",
+ "filename",
+ "status",
+ "expiresAt"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "error": {
+ "additionalProperties": false,
+ "properties": {
+ "code": {
+ "minLength": 1,
+ "type": "string"
+ },
+ "details": {
+ "additionalProperties": false,
+ "properties": {
+ "addressRole": {
+ "enum": [
+ "recipient",
+ "sender"
+ ]
+ },
+ "canSendAsEntered": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "addressRole",
+ "canSendAsEntered"
+ ],
+ "type": "object"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "error"
+ ],
+ "type": "object"
+ }
+ ],
+ "type": "object"
+}Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false; the description adds that it 'does not change the request or the document' and lists the exact returned artifacts, reinforcing the read-only behavior with concrete detail.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the purpose, then the return payload contract. Every clause earns its place with no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description usefully enumerates the return fields (document ID, SHA-256, page count, byte count, preview URL) and the possible states, so an agent knows what to expect; the remaining gap is the unexplained parameter.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% for the single required parameter documentRequestId, and the description never explains where this ID comes from or what qualifies as a valid/owned request, leaving the only parameter undocumented in both places.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Returns the state of an owned, single-use upload request') and enumerates the possible states, making its scope distinct from sibling write operations like prepare_document or upload_document.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied — poll this after initiating an upload — but the description never says when to call it versus alternatives or what triggers a status check. No explicit when/when-not guidance is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.