Skip to main content
Glama

get_comments

Retrieve comments from a Figma file to review feedback and track design discussions.

Instructions

Get comments on a Figma file

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileKeyYesThe key of the file to get comments from

Implementation Reference

  • The core handler function that makes an API request to retrieve comments for a Figma file using the provided fileKey.
    async getComments(args: GetCommentsArgs) {
      const { fileKey } = args;
      
      return this.api.makeRequest(`/files/${fileKey}/comments`);
    }
  • src/index.ts:221-233 (registration)
    Tool registration in the listTools response, defining the name, description, and input schema for 'get_comments'.
    {
      name: 'get_comments',
      description: 'Get comments on a Figma file',
      inputSchema: {
        type: 'object',
        properties: {
          fileKey: {
            type: 'string',
            description: 'The key of the file to get comments from'
          }
        },
        required: ['fileKey']
      },
  • src/index.ts:522-527 (registration)
    Dispatch logic in the CallToolRequest handler that routes 'get_comments' calls to the filesHandler.getComments method.
    case 'get_comments': {
      const args = this.validateArgs<GetCommentsArgs>(request.params.arguments, ['fileKey']);
      const result = await this.filesHandler.getComments(args);
      return {
        content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
      };
  • TypeScript interface defining the input arguments for the get_comments tool.
    export interface GetCommentsArgs {
      fileKey: string;
    }
Behavior2/5

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

With no annotations provided, the description carries full burden but only states the basic action without behavioral details. It lacks information on permissions, rate limits, pagination, return format, or error handling, which are critical for a read operation in an API context.

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 a single, direct sentence with zero wasted words, making it easy to parse and front-loaded. It efficiently communicates the core purpose without unnecessary elaboration.

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 the lack of annotations and output schema, the description is insufficient for a tool that likely returns structured data. It doesn't explain what 'comments' entail (e.g., text, metadata), how results are formatted, or any limitations, leaving gaps in understanding the tool's full behavior.

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 description coverage is 100%, so the input schema fully documents the 'fileKey' parameter. The description adds no additional meaning beyond implying the parameter is required, meeting the baseline for high schema coverage without extra value.

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 clearly states the verb ('Get') and resource ('comments on a Figma file'), making the tool's purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'post_comment' or 'delete_comment' beyond the basic action, missing explicit distinction about scope or limitations.

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. It doesn't mention prerequisites (e.g., needing a valid fileKey), exclusions, or comparisons to siblings like 'get_file' or 'post_comment', leaving the agent to infer usage context independently.

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/smithery-ai/mcp-figma'

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