Skip to main content
Glama

set_status

Set status key-value pairs for AI agents in terminal multiplexer workspaces to display agent states and progress indicators.

Instructions

Set a sidebar status key-value pair

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesStatus key
valueYesStatus value
workspaceNoTarget workspace ref
surfaceNoTarget surface ref
iconNoIcon name
colorNoHex color

Implementation Reference

  • The handler function for the 'set_status' MCP tool in src/server.ts, which validates the key and calls the underlying client.setStatus method.
    async (args) => {
      try {
        parseReservedModeKey(args.key, args.value);
        await client.setStatus(args.key, args.value, {
          icon: args.icon,
          color: args.color,
          workspace: args.workspace,
          surface: args.surface,
        });
        return ok({
          key: args.key,
          value: args.value,
          applied: "set_status",
        });
      } catch (e) {
        return err(e);
  • Input validation schema for the 'set_status' MCP tool.
    {
      key: z.string().describe("Status key"),
      value: z.string().describe("Status value"),
      workspace: z.string().optional().describe("Target workspace ref"),
      surface: z.string().optional().describe("Target surface ref"),
      icon: z.string().max(8).optional().describe("Icon name"),
      color: z
        .string()
        .regex(/^#[0-9a-fA-F]{6}$/)
        .optional()
        .describe("Hex color"),
    },
  • src/server.ts:424-426 (registration)
    Registration of the 'set_status' tool using the server.tool method.
    server.tool(
      "set_status",
      "Set a sidebar status key-value pair",
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 sets a key-value pair but doesn't explain what happens (e.g., whether it overwrites existing keys, requires specific permissions, or has side effects like UI updates). This is inadequate for a mutation tool with zero annotation coverage.

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 waste. It's front-loaded with the core action and target, making it easy to parse quickly without unnecessary elaboration.

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 no annotations and no output schema, the description is insufficient. It doesn't cover behavioral aspects like effects, error conditions, or return values, leaving significant gaps in understanding how to use the tool effectively in context with its siblings.

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 six parameters. The description adds no additional meaning beyond implying 'sidebar status' as the context for the key-value pair, but it doesn't clarify parameter interactions or usage examples. Baseline 3 is appropriate when the schema handles parameter documentation.

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 ('a sidebar status key-value pair'), making the purpose understandable. It doesn't explicitly distinguish from siblings like 'set_progress', but the specific mention of 'sidebar status' provides some differentiation. No tautology or misleading elements are present.

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 'set_progress' or other sibling tools. It lacks context about prerequisites, such as whether a sidebar or workspace must be active, and offers no explicit when-not-to-use scenarios or comparisons.

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