Skip to main content
Glama

subscriptions_create

Subscribe to document events to track changes, updates, or other activities on a Yonote document. Specify the document ID and event type to receive notifications.

Instructions

Subscribe to document events.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
eventYesEvent type to subscribe to
documentIdYesDocument ID
Behavior2/5

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

Annotations are absent, so the description bears full responsibility for disclosing behavioral effects. 'Subscribe' implies a state change, but there is no detail on permissions required, whether subscriptions are idempotent, what the return value is, or how to manage the subscription afterward. Minimal disclosure beyond the bare action.

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

Conciseness4/5

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

The description is a single, clear sentence with no wasted words. It is front-loaded and appropriately sized for a simple tool, though it lacks additional context that would make it more useful. The brevity is a positive, but it stops short of a fully structured explanation.

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

Completeness2/5

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

The tool has only 2 parameters with good schema coverage, but no output schema and no annotations. The description does not explain the subscription lifecycle, how events are delivered, or what happens after creation. This is insufficient for an agent to fully understand the tool's role within the broader API context, especially given sibling tools for managing subscriptions.

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 both parameters having descriptions ('Event type to subscribe to' and 'Document ID'). The description adds no additional semantic nuance beyond the schema, but it doesn't need to since the schema already documents the parameters adequately.

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

Purpose4/5

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

The description 'Subscribe to document events' uses a specific verb ('subscribe') and resource ('document events'), clearly indicating the creation of a subscription. It is distinct from sibling tools like subscriptions_info and subscriptions_delete, though the distinction is carried more by the tool name than the description itself.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives or what conditions must be met (e.g., existing document). The description only states what it does, not the context for its use or how it relates to other subscription tools like subscriptions_info or subscriptions_delete.

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/NikitaMurugov/yonote-mcp'

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