Skip to main content
Glama

annotate

Add or update annotations on Kubernetes resources to organize metadata, configure behavior, or add custom labels for management.

Instructions

Add or update annotations on a resource

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
resourceYesThe resource type
nameYesThe name of the resource
annotationsYesAnnotations to add/update (key=value,key2=value2)
namespaceNoThe namespace of the resource (optional, defaults to current context namespace)

Implementation Reference

  • The handler function for the 'annotate' tool. It destructures the input arguments, constructs a 'kubectl annotate' command with optional namespace, executes it using execAsync, and returns the stdout or a success message.
    case "annotate": {
      const { resource, name, annotations, namespace } = args;
      const nsArg = namespace ? `-n ${namespace}` : "";
      const cmd = `kubectl annotate ${resource} ${name} ${annotations} ${nsArg}`;
      const { stdout } = await execAsync(cmd);
      return {
        content: [{ type: "text", text: stdout || `Annotations updated on ${resource} ${name}` }]
      };
    }
  • The tool definition including name, description, and inputSchema for validating arguments to the 'annotate' tool.
      name: "annotate",
      description: "Add or update annotations on a resource",
      inputSchema: {
        type: "object",
        properties: {
          resource: { 
            type: "string",
            description: "The resource type"
          },
          name: { 
            type: "string",
            description: "The name of the resource"
          },
          annotations: { 
            type: "string",
            description: "Annotations to add/update (key=value,key2=value2)"
          },
          namespace: { 
            type: "string",
            description: "The namespace of the resource (optional, defaults to current context namespace)"
          }
        },
        required: ["resource", "name", "annotations"]
      }
    },
  • server.js:1392-1394 (registration)
    Registers the list tools handler which returns the array of all tools, including 'annotate', making it discoverable by MCP clients.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return { tools };
    });
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 the basic action without disclosing behavioral traits. It doesn't mention permission requirements, whether annotations are merged or replaced, side effects, or response format. 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 no wasted words. It's front-loaded with the core action and target, making it easy to parse quickly.

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 lacks details on behavior, error conditions, permissions, or output format. Given the complexity of modifying resources and the absence of structured safety hints, more context is needed.

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 parameters are documented in the schema. The description adds no additional meaning about parameters beyond implying annotations are key-value pairs. This meets the baseline for high schema coverage but doesn't enhance understanding.

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 ('Add or update') and target ('annotations on a resource'), making the purpose understandable. However, it doesn't differentiate from sibling tools like 'label' which also modifies resource metadata, leaving room for confusion about when to use each.

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 is provided on when to use this tool versus alternatives like 'label' or 'patch'. The description lacks context about appropriate scenarios, prerequisites, or exclusions, leaving the agent to infer usage from the tool name alone.

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/thekaranpargaie/kube-mcp'

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