Skip to main content
Glama

set_progress

Update progress indicators in the cmuxlayer sidebar to track agent task completion during terminal multiplexer operations.

Instructions

Set sidebar progress indicator (0.0 to 1.0)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
valueYesProgress value between 0 and 1
labelNoProgress label text
workspaceNoTarget workspace ref
surfaceNoTarget surface ref

Implementation Reference

  • src/server.ts:460-472 (registration)
    The 'set_progress' tool is registered in src/server.ts using server.tool.
    server.tool(
      "set_progress",
      "Set sidebar progress indicator (0.0 to 1.0)",
      {
        value: z
          .number()
          .min(0)
          .max(1)
          .describe("Progress value between 0 and 1"),
        label: z.string().optional().describe("Progress label text"),
        workspace: z.string().optional().describe("Target workspace ref"),
        surface: z.string().optional().describe("Target surface ref"),
      },
  • The handler for 'set_progress' calls client.setProgress and returns the result.
    async (args) => {
      try {
        await client.setProgress(args.value, {
          label: args.label,
          workspace: args.workspace,
          surface: args.surface,
        });
        return ok({
          value: args.value,
          label: args.label,
          applied: "set_progress",
        });
      } catch (e) {
Behavior2/5

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

With no annotations provided, the description carries full burden but only states what the tool does functionally. It doesn't disclose whether this is a UI-only change, if it persists across sessions, what permissions are needed, or how it affects user experience. For a mutation tool with zero annotation coverage, this is insufficient.

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?

Extremely concise single sentence with zero wasted words. The description is front-loaded with the core functionality and includes essential numeric constraints in parentheses.

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 4 parameters, no annotations, and no output schema, the description is inadequate. It doesn't explain what happens after setting the progress indicator, whether changes are visible immediately, what error conditions might occur, or how this integrates with the broader UI system.

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 4 parameters. The description adds minimal value by mentioning the 0.0-1.0 range for the 'value' parameter, but doesn't provide additional context about parameter interactions or semantics beyond what's already in the schema.

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 action ('Set') and the target resource ('sidebar progress indicator'), with specific numeric range context. It doesn't explicitly distinguish from sibling tools like 'set_status', but the resource specificity makes the purpose clear.

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?

No guidance on when to use this tool versus alternatives like 'set_status' or other UI manipulation tools. The description provides only functional information without context about appropriate use cases or prerequisites.

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/EtanHey/cmuxlayer'

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