Skip to main content
Glama

notion_create_comment

Add comments to Notion pages or existing discussion threads using rich text formatting, mentions, and equations.

Instructions

Create a comment in Notion. This requires the integration to have 'insert comment' capabilities. You can either specify a page parent or a discussion_id, but not both.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
parentNoParent object that specifies the page to comment on. Must include a page_id if used.
discussion_idNoThe ID of an existing discussion thread to add a comment to.It should be a 32-character string (excluding hyphens) formatted as 8-4-4-4-12 with hyphens (-).
rich_textYesArray of rich text objects representing the comment content.
formatNoSpecify the response format. 'json' returns the original data structure, 'markdown' returns a more readable format. Use 'markdown' when the user only needs to read the page and isn't planning to write or modify it. Use 'json' when the user needs to read the page with the intention of writing to or modifying it.markdown

Implementation Reference

  • MCP tool handler for 'notion_create_comment': validates input arguments and calls NotionClientWrapper.createComment method.
    case "notion_create_comment": {
      const args = request.params
        .arguments as unknown as args.CreateCommentArgs;
    
      if (!args.parent && !args.discussion_id) {
        throw new Error(
          "Either parent.page_id or discussion_id must be provided"
        );
      }
    
      response = await notionClient.createComment(
        args.parent,
        args.discussion_id,
        args.rich_text
      );
      break;
    }
  • Input schema and metadata definition for the 'notion_create_comment' tool.
    export const createCommentTool: Tool = {
      name: "notion_create_comment",
      description:
        "Create a comment in Notion. This requires the integration to have 'insert comment' capabilities. You can either specify a page parent or a discussion_id, but not both.",
      inputSchema: {
        type: "object",
        properties: {
          parent: {
            type: "object",
            description:
              "Parent object that specifies the page to comment on. Must include a page_id if used.",
            properties: {
              page_id: {
                type: "string",
                description:
                  "The ID of the page to comment on." + commonIdDescription,
              },
            },
          },
          discussion_id: {
            type: "string",
            description:
              "The ID of an existing discussion thread to add a comment to." +
              commonIdDescription,
          },
          rich_text: {
            type: "array",
            description:
              "Array of rich text objects representing the comment content.",
            items: richTextObjectSchema,
          },
          format: formatParameter,
        },
        required: ["rich_text"],
      },
    };
  • Registration of 'notion_create_comment' tool (as schemas.createCommentTool) in the list of available tools returned by ListToolsRequest.
    const allTools = [
      schemas.appendBlockChildrenTool,
      schemas.retrieveBlockTool,
      schemas.retrieveBlockChildrenTool,
      schemas.deleteBlockTool,
      schemas.updateBlockTool,
      schemas.retrievePageTool,
      schemas.updatePagePropertiesTool,
      schemas.listAllUsersTool,
      schemas.retrieveUserTool,
      schemas.retrieveBotUserTool,
      schemas.createDatabaseTool,
      schemas.queryDatabaseTool,
      schemas.retrieveDatabaseTool,
      schemas.updateDatabaseTool,
      schemas.createDatabaseItemTool,
      schemas.createCommentTool,
      schemas.retrieveCommentsTool,
      schemas.searchTool,
    ];
    return {
      tools: filterTools(allTools, enabledToolsSet),
    };
  • Core implementation of comment creation via Notion API POST /comments endpoint in NotionClientWrapper.
    async createComment(
      parent?: { page_id: string },
      discussion_id?: string,
      rich_text?: RichTextItemResponse[]
    ): Promise<CommentResponse> {
      const body: Record<string, any> = { rich_text };
      if (parent) {
        body.parent = parent;
      }
      if (discussion_id) {
        body.discussion_id = discussion_id;
      }
    
      const response = await fetch(`${this.baseUrl}/comments`, {
        method: "POST",
        headers: this.headers,
        body: JSON.stringify(body),
      });
    
      return response.json();
    }

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses the creation behavior and the mutual exclusivity constraint, but does not mention side effects, authentication details beyond the capability, or return format. The basic behavior is clear but lacks depth.

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 two sentences long, front-loaded with the action, and every sentence adds essential information. There is no redundancy or unnecessary detail.

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?

Given the complexity of the input schema (nested rich_text objects) and the absence of an output schema, the description provides key context. It could mention the return type (created comment object), but the schema's detailed parameter documentation compensates. Overall, it is sufficiently complete for an AI agent.

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

Parameters4/5

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

Schema coverage is 100% with detailed descriptions. The description adds value by explicitly stating the constraint that parent and discussion_id cannot both be provided, which is a critical semantic not obvious from the schema alone. The rich_text parameter is thoroughly documented in the schema.

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 'Create a comment in Notion' with clear verb and resource. It distinguishes between using page parent or discussion_id, and the tool name aligns with creation (unlike siblings like notion_retrieve_comments which is read-only).

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?

The description explains the 'insert comment' capability requirement and the mutual exclusivity of parent and discussion_id, guiding when to use each. However, it does not explicitly compare to other tools or state when not to use this tool, but the context is clear enough.

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