Skip to main content
Glama

update_post

Modify existing feedback posts in Canny by updating titles, descriptions, categories, status, or custom fields to keep customer feedback current and organized.

Instructions

Update an existing Canny post

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
categoryIdNoNew category ID for the post (optional)
customFieldsNoUpdated custom field values (optional)
detailsNoNew description for the post (optional)
postIdYesID of the post to update
statusNoNew status for the post (optional)
titleNoNew title for the post (optional)

Implementation Reference

  • The complete implementation of the update_post tool, including schema definition, handler logic that validates input, calls the Canny client to update the post, handles errors, and formats the response.
    export const updatePostTool = {
      name: 'update_post',
      description: 'Update an existing Canny post',
      inputSchema: {
        type: 'object',
        properties: {
          postId: { type: 'string', description: 'ID of the post to update' },
          title: { type: 'string', description: 'New title for the post (optional)' },
          details: { type: 'string', description: 'New description for the post (optional)' },
          categoryId: { type: 'string', description: 'New category ID for the post (optional)' },
          customFields: { 
            type: 'object', 
            description: 'Updated custom field values (optional)',
            additionalProperties: true 
          },
          status: { 
            type: 'string', 
            enum: ['open', 'under review', 'planned', 'in progress', 'complete', 'closed'],
            description: 'New status for the post (optional)' 
          },
        },
        required: ['postId'],
        additionalProperties: false,
      },
      handler: async (args: unknown, client: CannyClient) => {
        const { postId, title, details, categoryId, customFields, status } = validateToolInput<UpdatePostInput>(args, UpdatePostSchema);
        
        const response = await client.updatePost(postId, {
          title,
          details,
          categoryID: categoryId,
          customFields,
          status,
        });
        
        if (response.error) {
          throw new Error(`Failed to update post: ${response.error}`);
        }
    
        if (!response.data) {
          return 'Post update failed - no data returned';
        }
    
        const post = response.data;
        return `Successfully updated post!\n\n` +
          `**${post.title}** (ID: ${post.id})\n` +
          `Status: ${post.status}\n` +
          `Updated: ${new Date(post.updatedAt).toLocaleString()}\n` +
          `URL: ${post.url}`;
      },
    };
  • Zod schema (UpdatePostSchema) and TypeScript type (UpdatePostInput) for input validation of the update_post tool.
    const UpdatePostSchema = z.object({
      postId: z.string().min(1, 'Post ID is required'),
      title: z.string().optional(),
      details: z.string().optional(),
      categoryId: z.string().optional(),
      customFields: z.record(z.any()).optional(),
      status: z.enum(['open', 'under review', 'planned', 'in progress', 'complete', 'closed']).optional(),
    });
    
    type GetPostsInput = z.infer<typeof GetPostsSchema>;
    type GetPostInput = z.infer<typeof GetPostSchema>;
    type SearchPostsInput = z.infer<typeof SearchPostsSchema>;
    type CreatePostInput = z.infer<typeof CreatePostSchema>;
    type UpdatePostInput = z.infer<typeof UpdatePostSchema>;
  • Registration of the update_post tool (as updatePostTool) in the main tools array exported for use in the MCP server.
    export const tools: Tool[] = [
      // Board management
      getBoardsTool,
      
      // Post management
      getPostsTool,
      getPostTool,
      searchPostsTool,
      createPostTool,
      updatePostTool,
    
      // Extended functionality - temporarily disabled for debugging
      // getCategoresTool,
      // getCommentsTool,
      // getUsersTool,
      // getTagsTool,
    ];
  • Individual export of updatePostTool for testing and potential direct use.
    export {
      getBoardsTool,
      getPostsTool,
      getPostTool,
      searchPostsTool,
      createPostTool,
      updatePostTool,
      // getCategoresTool,
      // getCommentsTool,
      // getUsersTool,
      // getTagsTool,
    };
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. 'Update an existing Canny post' implies a mutation operation but doesn't specify required permissions, whether changes are reversible, rate limits, error conditions, or what the response contains. This leaves significant gaps for an agent to understand the tool's behavior beyond basic functionality.

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 states the core functionality without unnecessary words. It's appropriately sized for a straightforward update operation and front-loads the essential information ('Update an existing Canny post').

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?

For a mutation tool with 6 parameters, no annotations, and no output schema, the description is incomplete. It doesn't address behavioral aspects like permissions, side effects, or response format. While the schema covers parameters well, the overall context for safe and effective use requires more guidance than provided.

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 schema fully documents all 6 parameters. The description adds no additional parameter information beyond what's in the schema (e.g., no examples, format details, or constraints). This meets the baseline of 3 when the schema does the heavy lifting, but doesn't provide extra semantic 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 ('Update') and resource ('an existing Canny post'), making the purpose immediately understandable. It distinguishes from siblings like 'create_post' (create vs update) and 'get_post' (read vs update), though it doesn't explicitly mention these distinctions in the description text itself.

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 prerequisites (e.g., needing an existing post ID), when not to use it (e.g., for creating new posts), or refer to sibling tools like 'create_post' for creation or 'get_post' for reading instead of updating.

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