check_document_serviceCheck whether document conversion and extraction are available.
Use this before a workflow or when another document tool reports a temporary availability problem. No document input is required.
Returns: A dictionary with status='healthy', or an actionable error object.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover read-only, idempotent, and non-destructive behavior. The description adds the return format (dictionary with status='healthy' or an actionable error object) and reinforces that no input is needed. This adds useful context beyond the annotations without contradiction.
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 concise and front-loaded: first sentence states the purpose, second gives usage guidance, third clarifies no input, and return info is presented. Each sentence adds value with no redundancy.
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 zero-parameter health check tool, the description covers what it does, when to use it, and what it returns. It even specifies the error format. Combined with the safety annotations, nothing essential is missing for an agent to use it correctly.
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?
With 0 parameters and 100% schema coverage, the baseline is 4. The description clarifies that no document input is required, which aligns with the empty schema. No further parameter explanation is necessary.
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 states a specific action ('Check whether document conversion and extraction are available') and clarifies the resource. It also explicitly distinguishes from siblings by noting that no document input is required, which differentiates it from the extraction tools.
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?
Provides explicit usage scenarios: 'before a workflow' and 'when another document tool reports a temporary availability problem'. This gives clear context and implies when not to use it (i.e., for actual extraction), and the note about no input further clarifies its role.
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.
Each tool targets a distinct operation: service health checking, image-based field extraction, and PDF-to-Markdown conversion. The descriptions explicitly separate image vs PDF input and structured fields vs Markdown output, so there is no meaningful overlap.
check_document_service and extract_document_fields follow a clear verb_noun pattern, while pdf_to_markdown uses a conventional format-conversion style. The consistent snake_case naming and domain-specific verbs keep the set predictable despite the one stylistic deviation.
Three tools is well-scoped for a focused document conversion and extraction service. Each tool earns its place, and the included health check supports workflow reliability without adding unnecessary bloat.
The core document workflows are covered: PDFs become Markdown, document images become structured fields and text, and availability is checkable. Direct PDF-to-fields and image-to-Markdown paths are missing, but agents can work around these using the text and Markdown outputs, making these minor gaps rather than fatal omissions.