Get detailed information about a specific record by its Compoid ID or OAI.
| Name | Required | Description | Default |
|---|---|---|---|
| work_id | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. The verb 'Get' suggests a read-only operation, but the description does not explicitly confirm safety, side effects, error behavior, or authentication requirements. It adds no behavioral context beyond the function's name.
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 a single, front-loaded sentence with no redundant words. It states the action, target, and identifier options efficiently.
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?
The tool is a simple getter with one parameter and an output schema, so the description needn't detail return values. It adequately explains what the tool does and how to identify the target, though it omits potential error conditions or authorization notes.
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%, but the description compensates by explaining that the 'work_id' parameter accepts either a Compoid ID or an OAI. This gives meaning to an otherwise opaque parameter name, though it does not provide format examples or further constraints.
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 the tool's function: 'Get detailed information about a specific record' and specifies the selection criteria ('by its Compoid ID or OAI'). This distinguishes it from sibling tools like search_records (which lists records) and get_community_details (which targets communities).
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?
The phrase 'specific record' implies this tool is for retrieving details of a single known entity, as opposed to searching. However, there is no explicit guidance on when to use this tool versus alternatives, nor any exclusions or prerequisites.
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 resource-action pair (create/get/update/search for communities and records, plus upload/download for files). No two tools have overlapping purposes; even get_record_details and download_files are clearly separated by metadata vs file retrieval.
All tools follow a consistent 'Compoid_<verb>_<noun>' pattern in snake_case, e.g., create_community, get_record_details, search_records. The prefix and verb-noun structure are uniform across the entire set, making the naming predictable.
With 10 tools, the server is well-scoped for managing two core resources (communities and records) plus file operations. Each tool serves a clear purpose without redundancy, and the count feels appropriate rather than bloated or thin.
The server provides create, read, update, and search for both communities and records, along with upload and download for files. The only notable gap is the absence of delete operations for either resource, but the core lifecycle (search, create, retrieve, update) is well covered.