Returns the state of an owned, single-use upload request, including whether it is awaiting upload, uploading, complete or expired. A completed upload includes its private document ID, SHA-256, page count, byte count and authenticated preview URL.
| 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 establish readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds meaningful behavioral context by specifying the status vocabulary (awaiting upload, uploading, complete, expired) and the result fields for completed uploads, which is especially valuable given there is no output schema.
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?
The description is two sentences with no filler. The core purpose and states are front-loaded, followed by a compact list of result fields. Every sentence contributes necessary information.
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?
For a simple one-parameter read-only tool with strong annotations stubscrib, the description covers the return states and key result fields despite lacking an output schema. It only falls slightly short of full completeness by omitting guidance on how to retrieve or construct a valid documentRequestId and what happens when the request is expired or not found.
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%, so the description must compensate. It does clarify that documentRequestId refers to an 'owned, single-use upload request', giving the parameter needed context beyond the raw schema. However, it does not explain how to obtain this ID, its format, or any constraints such as expiration timing.
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?
The description uses a specific verb ('Returns') and a precise resource ('the state of an owned, single-use upload request'), then enumerates the possible states and the data included in a completed result. This clearly separates it from sibling tools like postedly_order_status and postedly_upload_document by focusing on the upload request lifecycle.
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?
No explicit guidance is given about when to use this tool versus alternatives such as postedly_prepare_document or postedly_upload_document. The description implies it should be used to check upload request status, but it does not state conditions, exclusions, or reference any sibling tool.
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.