Skip to main content
Glama

API-create-a-comment

Add comments to Notion pages programmatically using specified page IDs and rich text content. Integrates with the Notion API for streamlined interaction and management within workspaces.

Instructions

Notion | Create comment

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
parentYesThe page that contains the comment
rich_textYes
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states 'Create comment' which implies a write operation, but doesn't disclose behavioral traits such as authentication needs, rate limits, whether it's idempotent, or what happens on failure. For a mutation tool with zero annotation coverage, this is a significant gap in transparency.

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 extremely concise with 'Notion | Create comment', which is front-loaded and wastes no words. Every part of the two-word phrase contributes to understanding, making it efficient despite its brevity.

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?

Given a mutation tool with no annotations, 50% schema coverage, no output schema, and nested parameters, the description is incomplete. It doesn't address behavioral aspects, parameter meanings, or usage context, leaving significant gaps for an AI agent to operate effectively.

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

Parameters2/5

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

Schema description coverage is 50% (only 'parent' has a description), and the description adds no parameter information beyond the tool name. It doesn't explain what 'parent' or 'rich_text' mean in context, their formats, or constraints. With low schema coverage and no compensation in the description, parameters remain poorly documented.

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

Purpose3/5

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

The description 'Notion | Create comment' states the action (create) and resource (comment) but is vague about scope and lacks specificity. It doesn't distinguish this from sibling tools like 'API-retrieve-a-comment' or 'API-update-a-block', which could also involve comments. The purpose is clear at a basic level but lacks detail about what exactly is being created.

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. With siblings like 'API-retrieve-a-comment' and 'API-update-a-block', there's no indication of prerequisites, context (e.g., commenting on pages vs. databases), or exclusions. The description offers no usage context, leaving the agent to infer from tool names alone.

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

Related 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/punkpeye/notion-mcp-server-3'

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