Skip to main content
Glama
CNSLabs

Shodai Agreements

Get agreement state

get_agreement_state
Read-onlyIdempotent

Retrieve the current state of an agreement to monitor transitions after submitting participant input. Check the state against the defined lifecycle for deployed agreements.

Instructions

Returns the current state of an agreement. For deployed agreements, interpret the state against the states defined in the authored agreement lifecycle (execution.states). Use this to poll for transitions after submitting an input.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
agreementIdYesAgreement record ID, as returned by list_agreements (not the on-chain address).
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint. Description adds valuable context about interpreting state relative to the lifecycle, which goes beyond annotation signals.

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?

Two sentences, front-loaded with purpose, no unnecessary words. Every sentence adds value.

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?

No output schema is provided, which might be a gap, but the description sufficiently explains the return value's semantics and usage pattern. For a simple state-retrieval tool, it is mostly complete.

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 coverage is 100% with a well-described single parameter. The tool description does not add additional parameter meaning beyond the schema, so baseline score of 3 applies.

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?

Clearly states verb ('Returns') and resource ('state of an agreement'), distinguishes from siblings like get_agreement by focusing on state and adding context about lifecycle interpretation.

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

Usage Guidelines4/5

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

Explicitly advises polling scenario ('Use this to poll for transitions after submitting an input'), providing clear context. Does not mention when not to use or list alternatives, but guidance is specific and helpful.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/CNSLabs/agreements-api-sdk'

If you have feedback or need assistance with the MCP directory API, please join our Discord server