Create an app encryption declaration document by providing file name, size, and the associated declaration, initiating the upload process.
Create an app encryption declaration document. [POST /v1/appEncryptionDeclarationDocuments]
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | JSON:API request body (Apple schema: AppEncryptionDeclarationDocumentCreateRequest). |
Changes observed during successful MCP inspections.
v1.3.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations indicate readOnlyHint=false, idempotentHint=false, destructiveHint=false. The description explicitly says 'Create', confirming mutation. However, no additional behavioral traits like authentication needs or rate limits are mentioned.
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?
Single concise sentence plus the endpoint URL. No redundancy, front-loaded with key action.
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?
No output schema, so return value is unspecified. The description does not explain the creation workflow or how this tool fits with others (e.g., subsequent upload steps). Limited context for an agent to understand the full process.
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 coverage is 100% with a helpful description: 'JSON:API request body (Apple schema: AppEncryptionDeclarationDocumentCreateRequest).' The tool description adds the endpoint path but no further parameter meaning beyond what the schema provides.
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 clearly states 'Create an app encryption declaration document', which is a specific verb-noun pair. It distinguishes from sibling tools like app_encryption_declaration_documents__get and app_encryption_declaration_documents__update.
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 guidance on when to use this tool versus alternatives (e.g., prerequisites like having an app encryption declaration). The description only states the action, leaving agents to infer context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.