Skip to main content
Glama
ironfrancis

fast-h3yun

by ironfrancis

h3yun_get_record

Retrieve a single business record from H3 Yun by providing its ObjectId and schema code.

Instructions

Load one business record by ObjectId.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
object_idYesRecord ObjectId.
schema_codeYesForm schemaCode / node code.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full transparency burden. 'Load' clearly conveys a read-only retrieval and does not suggest mutation, but it does not disclose authentication requirements, behavior when the ObjectId is not found, or any other operational traits. Adequate but with clear gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, direct sentence with no filler. The action and the primary retrieval key are front-loaded, making the purpose immediately scannable for an agent.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple get-by-id tool with only two required parameters, full schema coverage, and an output schema, the description is mostly sufficient for correct invocation. It lacks explicit sibling differentiation and authentication/session context, but those are not essential when the caller already has a known ObjectId.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and the input schema already defines object_id as 'Record ObjectId.' and schema_code as 'Form schemaCode / node code.' The description adds little beyond reinforcing that object_id is the lookup key, so it does not meaningfully enrich the structured parameter documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific action ('Load'), a concrete resource ('one business record'), and the lookup mechanism ('by ObjectId'). The singular 'one' and use of ObjectId clearly distinguish it from the sibling h3yun_query_records, which implies searching/filtering rather than direct retrieval.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'by ObjectId' implies the tool should be used when the caller already knows the exact ID of a single record. However, it does not explicitly say when not to use it, does not name h3yun_query_records as the alternative for searching, and provides no guidance about prerequisites such as authentication.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.