Skip to main content
Glama

esa_update_post

Modify existing posts in esa by updating content, title, tags, category, or status using post number identification.

Instructions

Update an existing post

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
post_numberYesPost number to update
nameNoNew title for the post
body_mdNoNew body for the post (Markdown format)
tagsNoNew list of tags for the post
categoryNoNew category for the post
wipNoWhether to mark as WIP (Work In Progress)
messageNoChange message
created_byNoPoster's screen_name (only team owners can specify)
original_revisionNoRevision to base the update on

Implementation Reference

  • MCP tool dispatcher case for 'esa_update_post': validates arguments, calls EsaClient.updatePost, and formats the response.
    case "esa_update_post": {
      const args = request.params.arguments as unknown as UpdatePostArgs;
      if (!args.post_number) {
        throw new Error("post_number is required");
      }
      const { post_number, ...postData } = args;
      const response = await esaClient.updatePost(post_number, postData);
      return {
        content: [{ type: "text", text: JSON.stringify(response) }],
      };
    }
  • EsaClient method that executes the HTTP PATCH request to update an existing esa post.
    async updatePost(post_number: number, postData: Omit<UpdatePostArgs, 'post_number'>): Promise<any> {
      const url = `${this.baseUrl}/posts/${post_number}`;
      const response = await fetch(url, {
        method: "PATCH",
        headers: this.headers,
        body: JSON.stringify({ post: postData }),
      });
    
      return response.json();
    }
  • Tool definition object for 'esa_update_post' including name, description, and input schema.
    const updatePostTool: Tool = {
      name: "esa_update_post",
      description: "Update an existing post",
      inputSchema: {
        type: "object",
        properties: {
          post_number: {
            type: "number",
            description: "Post number to update",
          },
          name: {
            type: "string",
            description: "New title for the post",
          },
          body_md: {
            type: "string",
            description: "New body for the post (Markdown format)",
          },
          tags: {
            type: "array",
            items: { type: "string" },
            description: "New list of tags for the post",
          },
          category: {
            type: "string",
            description: "New category for the post",
          },
          wip: {
            type: "boolean",
            description: "Whether to mark as WIP (Work In Progress)",
          },
          message: {
            type: "string",
            description: "Change message",
          },
          created_by: {
            type: "string",
            description: "Poster's screen_name (only team owners can specify)",
          },
          original_revision: {
            type: "string",
            description: "Revision to base the update on",
          },
        },
        required: ["post_number"],
      },
    };
  • TypeScript interface defining the arguments for updating a post.
    interface UpdatePostArgs {
      post_number: number;
      name?: string;
      body_md?: string;
      tags?: string[];
      category?: string;
      wip?: boolean;
      message?: string;
      created_by?: string;
      original_revision?: string;
    }
  • index.ts:604-619 (registration)
    Registers 'esa_update_post' tool (via updatePostTool) in the ListTools response.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      console.error("ListToolsRequest received");
      return {
        tools: [
          listPostsTool,
          getPostTool,
          createPostTool,
          updatePostTool,
          listCommentsTool,
          getCommentTool,
          createCommentTool,
          getMembersTool,
          getMemberTool,
        ],
      };
    });
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. It states 'Update an existing post' which implies a mutation operation, but doesn't disclose any behavioral traits such as required permissions, whether updates are reversible, rate limits, or what happens to unspecified fields (e.g., are they preserved or reset?). This leaves significant gaps for an agent to understand the tool's behavior safely.

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 with zero wasted words. It's front-loaded with the core action ('Update an existing post'), making it immediately scannable. Every word earns its place by conveying essential purpose 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 complexity of a 9-parameter mutation tool with no annotations and no output schema, the description is insufficiently complete. It lacks behavioral context (e.g., permissions, side effects), usage guidelines, and any information about return values or error conditions. While the schema covers parameters well, the overall context for safe and effective use is inadequate.

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 all 9 parameters with clear descriptions. The description adds no parameter-specific information beyond what's in the schema (e.g., it doesn't explain interactions between parameters or provide examples). This meets the baseline of 3 since the schema does the heavy lifting, but the description doesn't compensate with additional semantic context.

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 post'), making the purpose immediately understandable. It distinguishes from siblings like 'esa_create_post' by specifying 'existing' rather than creating new. However, it doesn't explicitly differentiate from other update-like operations or provide nuanced scope details.

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 (like needing the post number), when not to use it (e.g., for minor edits vs. major revisions), or compare it to sibling tools like 'esa_create_post' for new content or 'esa_get_post' for retrieval. Usage context is entirely implied from the tool name.

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/kajirita2002/esa-mcp-server'

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