articleArticleARead-onlyIdempotentInspect
Fetch full metadata for a single Figshare article by numeric id, optionally at a specific version. Returns title, authors, description, DOI, license, categories, and file list.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| version | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| id | No | Article ID |
| doi | No | Digital Object Identifier |
| url | No | Article URL |
| tags | No | Article tags |
| cites | No | Citation count |
| title | No | Article title |
| views | No | View count |
| handle | No | Figshare handle |
| shares | No | Share count |
| authors | No | List of authors |
| downloads | No | Download count |
| is_public | No | Public visibility |
| categories | No | Article categories |
| description | No | Article description |
| modified_date | No | Last modified date |
| published_date | No | Publication date |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, destructiveHint false, idempotent. Description adds return field details (title, authors, etc.), providing useful context beyond annotations.
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 sentence with no fluff, front-loaded verb 'Fetch', efficient at 180 characters.
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 output schema present, description need not explain returns but still lists key fields. Could mention alternative tools for partial metadata.
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 0%, so description compensates by stating 'by numeric id' and 'optionally at a specific version', adding meaning beyond type definitions.
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?
Description clearly states 'Fetch full metadata for a single Figshare article by numeric id', distinguishing it from sibling tools like 'articles' (plural) and 'article_files'.
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?
Implicit usage is clear (when you need full metadata for one article), but no explicit guidance on when to use alternatives or when not to use this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.