Skip to main content
Glama
listingbureau

Listing Bureau - Amazon Organic Ranking

lb_projects_update

Idempotent

Toggle a project's active status to pause or resume Amazon organic ranking campaigns.

Instructions

Update a Listing Bureau project. Currently supports toggling the active status (pause/resume). To archive a project, use lb_projects_archive instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ui_idYesProject unique identifier
activeNoSet active status (true=resume, false=pause)

Implementation Reference

  • Registration of the lb_projects_update tool via server.tool(), includes schema definition (ui_id, active), hints, and the handler function.
    server.tool(
      "lb_projects_update",
      "Update a Listing Bureau project. Currently supports toggling the active status (pause/resume). To archive a project, use lb_projects_archive instead.",
      {
        ui_id: z.string().describe("Project unique identifier"),
        active: z.boolean().optional().describe("Set active status (true=resume, false=pause)"),
      },
      { idempotentHint: true  },
      async (params) => {
        try {
          const body: Record<string, unknown> = {};
          if (params.active !== undefined) body.action = params.active ? "activate" : "pause";
    
          if (Object.keys(body).length === 0) {
            return formatErrorResult(
              new Error("At least one field (active) must be provided"),
            );
          }
    
          const res = await client.request<Project>(
            "PATCH",
            `/api/v1/projects/${encodeURIComponent(params.ui_id)}`,
            body,
            undefined,
            "lb_projects_update",
          );
          return formatResult(res.data);
        } catch (e) {
          return formatErrorResult(e);
        }
      },
    );
  • Handler for lb_projects_update: builds a body with action 'activate' or 'pause' based on the active param, sends PATCH request to /api/v1/projects/{ui_id}, and returns formatted result.
      async (params) => {
        try {
          const body: Record<string, unknown> = {};
          if (params.active !== undefined) body.action = params.active ? "activate" : "pause";
    
          if (Object.keys(body).length === 0) {
            return formatErrorResult(
              new Error("At least one field (active) must be provided"),
            );
          }
    
          const res = await client.request<Project>(
            "PATCH",
            `/api/v1/projects/${encodeURIComponent(params.ui_id)}`,
            body,
            undefined,
            "lb_projects_update",
          );
          return formatResult(res.data);
        } catch (e) {
          return formatErrorResult(e);
        }
      },
    );
  • Input schema for lb_projects_update: ui_id (string, required) and active (boolean, optional).
    {
      ui_id: z.string().describe("Project unique identifier"),
      active: z.boolean().optional().describe("Set active status (true=resume, false=pause)"),
    },
  • src/index.ts:58-58 (registration)
    Registration call of registerProjectsTools in the main index.ts, which wires lb_projects_update into the MCP server.
    registerProjectsTools(server, client);
Behavior4/5

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

Descriptions adds behavioral context: toggling active status (pause/resume). Annotations already provide idempotentHint, and description does not contradict. No side effects detailed, but sufficient for this simple update.

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?

Two sentences, front-loaded with main purpose, no wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple update tool with 2 params and no output schema, the description covers purpose, usage, and alternative, making it complete.

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 coverage is 100%, so baseline is 3. Description primarily restates schema descriptions (e.g., 'Set active status (true=resume, false=pause)') without adding new semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states 'Update a Listing Bureau project' with specific verb and resource, and specifies that it currently only supports toggling active status. This differentiates it from sibling tools like lb_projects_archive.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says when to use (to toggle active status) and when not to use ('To archive a project, use lb_projects_archive instead'), providing clear guidance.

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/listingbureau/listingbureau-mcp'

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