hypathesis

Get Variable Relationships

get_variable_relationships

Read-onlyIdempotent

Retrieve analyzed variable relationships for a completed paper.

Only returns results when get_analysis_status reports status='Ready'.

Without an API key (anonymous): returns the relationship list with
source, target, and direction — but detailed reasoning is available
only with an API key. Sign up at https://hypathesis.com to get one.

Args:
    file_id: The file_id returned by the /upload endpoint.
    authorization: Optional. API key as 'Bearer hk_...' or 'hk_...'.
    session_token: Optional. The session_token returned by /upload for anonymous uploads.

Returns:
    Authenticated: full details (source, target, directed, reason per
    relationship; name, measure per variable).
    Anonymous: gated (source, target, directed per relationship;
    name per variable; sign_up_url for full access).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`file_id`	Yes
`authorization`	No
`session_token`	No

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

TDQS

A5/5.0

Behavior5/5

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

Beyond the readOnly/idempotent/destructive annotations, the description discloses the status gate, the anonymous-vs-authenticated response difference, and the sign-up action needed for full access. It is consistent with annotations and leaves no surprising mutation behavior.

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?

The description is front-loaded with a one-sentence purpose, then uses compact Args/Returns blocks. Every paragraph adds a distinct piece of information: readiness, auth handling, parameter origins, and response shape.

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

Completeness5/5

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

For a tool with one required parameter, two optional auth parameters, and an output schema, the description supplies everything needed to call it correctly and interpret the result. The only omitted detail, behavior when status is not Ready, is safely implied by the explicit precondition.

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

Parameters5/5

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

Schema description coverage is 0%, so the description carries the full parameter burden. It explains file_id's origin (/upload endpoint), authorization's accepted formats ('Bearer hk_...' or 'hk_...'), and session_token's role for anonymous uploads.

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 opening sentence names the exact operation ('Retrieve analyzed variable relationships') and scopes it to 'a completed paper'. It also explicitly references get_analysis_status, distinguishing this tool from the status-checking sibling.

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

Usage Guidelines5/5

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

It states the readiness precondition ('Only returns results when get_analysis_status reports status="Ready"'), which tells an agent when calling will be productive. It also provides clear auth-mode guidance: anonymous calls get gated results, while API-key calls get full details.

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

All hypathesis tools Inspect

Try in Browser

RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.8/5.0

Disambiguation5/5

Each tool has a distinct purpose: two for authentication flow (initiate, check), one for status polling, one for retrieving results. No overlap or ambiguity.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (initiate_device_auth, check_device_auth, get_analysis_status, get_variable_relationships), making them predictable.

Tool Count5/5

Four tools is well-scoped for a focused service handling authentication, status checking, and result retrieval without unnecessary bloat.

Completeness3/5

The tools cover auth and retrieval but lack an upload tool, requiring external action to start the workflow. This is a notable gap for a complete lifecycle.

Resources

Need Help?