Skip to main content
Glama

get_post

Retrieve detailed information about a specific customer feedback post from Canny.io using the post ID to access comprehensive feedback data.

Instructions

Get detailed information about a specific Canny post

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
postIdYesID of the post to retrieve

Implementation Reference

  • Core implementation of the 'get_post' tool, including name, description, input schema, and handler function that validates input, calls the Canny API client, handles errors, and returns formatted post details.
    export const getPostTool = {
      name: 'get_post',
      description: 'Get detailed information about a specific Canny post',
      inputSchema: {
        type: 'object',
        properties: {
          postId: { type: 'string', description: 'ID of the post to retrieve' },
        },
        required: ['postId'],
        additionalProperties: false,
      },
      handler: async (args: unknown, client: CannyClient) => {
        const { postId } = validateToolInput<GetPostInput>(args, GetPostSchema);
        
        const response = await client.getPost(postId);
        
        if (response.error) {
          throw new Error(`Failed to fetch post: ${response.error}`);
        }
    
        if (!response.data) {
          return `Post with ID ${postId} not found.`;
        }
    
        const post = response.data;
        return `**${post.title}**\n` +
          `ID: ${post.id}\n` +
          `Status: ${post.status}\n` +
          `Author: ${post.author.name} (${post.author.email || 'No email'})\n` +
          `Board: ${post.board.name}\n` +
          `Category: ${post.category?.name || 'None'}\n` +
          `Votes: ${post.votes} | Score: ${post.score}\n` +
          `Tags: ${post.tags.length > 0 ? post.tags.map(tag => tag.name).join(', ') : 'None'}\n` +
          `Created: ${new Date(post.createdAt).toLocaleString()}\n` +
          `Updated: ${new Date(post.updatedAt).toLocaleString()}\n` +
          `URL: ${post.url}\n\n` +
          `**Details:**\n${post.details || 'No description provided'}`;
      },
    };
  • Zod validation schema for get_post tool input parameters.
    const GetPostSchema = z.object({
      postId: z.string().min(1, 'Post ID is required'),
    });
  • Registration of all tools including getPostTool in the main tools export array used for MCP tool discovery.
    export const tools: Tool[] = [
      // Board management
      getBoardsTool,
      
      // Post management
      getPostsTool,
      getPostTool,
      searchPostsTool,
      createPostTool,
      updatePostTool,
    
      // Extended functionality - temporarily disabled for debugging
      // getCategoresTool,
      // getCommentsTool,
      // getUsersTool,
      // getTagsTool,
    ];
  • CannyClient method invoked by the get_post handler to retrieve post data from the Canny API.
    async getPost(postId: string): Promise<CannyApiResponse<CannyPost>> {
      return this.makeRequest<CannyPost>({
        method: 'GET',
        url: '/posts/retrieve',
        params: { id: postId },
      });
    }
  • src/tools/index.ts:3-9 (registration)
    Import statement that brings getPostTool into the index for registration.
    import { 
      getPostsTool, 
      getPostTool, 
      searchPostsTool, 
      createPostTool, 
      updatePostTool 
    } from './posts.js';
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 the tool retrieves 'detailed information' but doesn't clarify whether this is a read-only operation, what permissions are required, if there are rate limits, or what format the returned information takes. This leaves significant gaps for an agent to understand the tool's 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 a single, efficient sentence that directly states the tool's purpose without any wasted words. It is appropriately sized and front-loaded, making it easy for an agent to parse quickly.

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 incomplete. It doesn't address behavioral aspects like safety, permissions, or response format, which are crucial for a tool that retrieves data. While concise, it fails to compensate for the missing structured information, leaving the agent with insufficient context.

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?

The schema description coverage is 100%, with the single parameter 'postId' clearly documented in the schema. The description adds no additional parameter semantics beyond what the schema provides, such as format examples or constraints, so it meets the baseline for high schema coverage without adding 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 ('detailed information about a specific Canny post'), making the purpose immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'get_posts' (plural) or 'search_posts', which likely retrieve multiple posts rather than a single specific one.

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 like 'get_posts' or 'search_posts'. It implies usage for retrieving a single post by ID but doesn't specify prerequisites, exclusions, or contextual recommendations for choosing between sibling tools.

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/itsocialist/canny-mcp-server'

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