Skip to main content
Glama
TykanN

Swit MCP Server

by TykanN

swit-message-comment-list

Retrieve comments on a specific message in Swit collaboration tools to view discussions and track feedback.

Instructions

Retrieve list of comments on message

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
message_idYes
offsetNo
limitNo

Implementation Reference

  • The primary handler function for the 'swit-message-comment-list' tool. Validates input arguments using Zod schema and delegates to SwitClient's listMessageComments method.
    export const handleMessageCommentList = async (switClient: SwitClient, args: any) => {
      const validatedArgs = MessageCommentListArgsSchema.parse(args);
      return await switClient.listMessageComments(validatedArgs);
    };
  • Zod schema defining the input arguments for the tool: requires message_id, optional offset and limit for pagination.
    export const MessageCommentListArgsSchema = z.object({
      message_id: z.string(),
      offset: z.string().optional(),
      limit: z.number().min(1).max(100).optional(),
    });
  • Registration of tool handlers, mapping 'swit-message-comment-list' to its handler function.
    export const coreHandlers = (switClient: SwitClient) => ({
      'swit-workspace-list': (args: any) => handleWorkspaceList(switClient, args),
      'swit-channel-list': (args: any) => handleChannelList(switClient, args),
      'swit-message-create': (args: any) => handleMessageCreate(switClient, args),
      'swit-message-comment-create': (args: any) => handleMessageCommentCreate(switClient, args),
      'swit-message-comment-list': (args: any) => handleMessageCommentList(switClient, args),
      'swit-project-list': (args: any) => handleProjectList(switClient, args),
    });
  • src/index.ts:109-109 (registration)
    Final registration of all tool handlers into the MCP server's toolHandlers map after initialization.
    toolHandlers = { ...oauthHandlers(oauthWebServer), ...coreHandlers(switClient) };
  • Tool metadata definition including name, description, and input JSON schema for listTools endpoint.
    {
      name: 'swit-message-comment-list',
      description: 'Retrieve list of comments on message',
      inputSchema: zodToJsonSchema(MessageCommentListArgsSchema),
    },
  • Underlying SwitClient method that performs the actual API call to retrieve message comments.
    async listMessageComments(args: MessageCommentListArgs): Promise<MessageCommentListResponse> {
      const response = await this.client.get('/api/message.comment.list', { params: args });
      return response.data;
    }
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states this is a retrieval operation, implying it's likely read-only and non-destructive, but doesn't confirm this explicitly. It lacks details about authentication requirements, rate limits, error conditions, or the format/structure of the returned comment list. For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior.

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 at just one sentence with no wasted words. It's front-loaded with the core action ('Retrieve list of comments on message'), making it immediately understandable. Every word earns its place by conveying essential information without redundancy or fluff.

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 tool's moderate complexity (3 parameters, no output schema, no annotations), the description is incomplete. It doesn't address key contextual elements like how comments are structured in the response, pagination behavior implied by offset/limit parameters, or error handling. For a list retrieval tool with multiple parameters, more guidance is needed to make it fully usable by an AI agent.

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?

The description mentions retrieving comments 'on message', which hints at the 'message_id' parameter, but doesn't explain what this ID represents or how to obtain it. With 0% schema description coverage and three parameters (message_id, offset, limit), the description fails to compensate for the lack of schema documentation. It doesn't clarify the purpose of 'offset' and 'limit' for pagination, leaving parameters largely unexplained.

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 ('Retrieve') and resource ('list of comments on message'), making the purpose unambiguous. It doesn't explicitly differentiate from sibling tools like 'swit-message-comment-create', but the verb 'Retrieve' versus 'Create' provides implicit distinction. The description avoids tautology by specifying what is being retrieved rather than just restating the tool name.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention sibling tools like 'swit-message-comment-create' for creating comments or 'swit-channel-list' for related channel operations. There's no context about prerequisites, such as needing a valid message_id from another operation, or limitations like pagination handling.

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/TykanN/swit-mcp'

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