Skip to main content
Glama

describe-deployment

Retrieve detailed status and configuration information for a specific Kubernetes deployment to monitor its health and troubleshoot issues.

Instructions

Describe details of a Kubernetes deployment

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
deploymentYesThe name of the deployment to describe
namespaceNoThe namespace of the deployment (optional, defaults to current context namespace)

Implementation Reference

  • The execution handler for the 'describe-deployment' tool. It destructures the deployment name and optional namespace from arguments, constructs a kubectl describe command, executes it using execAsync, and returns the stdout as text content or a fallback message if no output.
    case "describe-deployment": {
      const { deployment, namespace } = args;
      const nsArg = namespace ? `-n ${namespace}` : "";
      const cmd = `kubectl describe deployment ${deployment} ${nsArg}`;
      const { stdout } = await execAsync(cmd);
      return {
        content: [{ type: "text", text: stdout || "No deployment details found" }]
      };
    }
  • The tool schema definition including name, description, and inputSchema for validation. This object is part of the static 'tools' array returned in response to ListTools requests, effectively registering the tool.
    name: "describe-deployment",
    description: "Describe details of a Kubernetes deployment",
    inputSchema: {
      type: "object",
      properties: {
        deployment: { 
          type: "string",
          description: "The name of the deployment to describe"
        },
        namespace: { 
          type: "string",
          description: "The namespace of the deployment (optional, defaults to current context namespace)"
        }
      },
      required: ["deployment"]
    }
  • server.js:1392-1394 (registration)
    The request handler for ListToolsRequestSchema that returns the static list of tools (including describe-deployment), which serves as the tool registration mechanism in MCP.
    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 for behavioral disclosure. It states it 'describes details' but doesn't specify what details are returned, whether it's a read-only operation, potential error conditions, or output format. For a Kubernetes tool that could return complex deployment information, this is insufficient behavioral context.

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 that communicates the core purpose without unnecessary words. It's appropriately sized for a straightforward tool and front-loads the essential information (describe Kubernetes deployment).

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 Kubernetes deployment description tool with no annotations and no output schema, the description is inadequate. It doesn't explain what 'details' are returned (configuration, status, pods, events?), doesn't mention authentication requirements, and provides no context about the complexity of Kubernetes deployments. Given the rich sibling tool ecosystem, more completeness 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%, with both parameters ('deployment' and 'namespace') clearly documented in the schema. The description adds no additional parameter information beyond what's already in the structured schema, so it meets but doesn't exceed the baseline expectation when schema coverage is complete.

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 ('describe details') and resource ('Kubernetes deployment'), making the tool's purpose immediately understandable. It doesn't differentiate from sibling tools like 'describe-pod' or 'describe-service' beyond the resource type, but the verb+resource combination is specific enough for basic understanding.

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 'list-deployments' (for overview) or 'get-cluster-metrics' (for performance data). There's no mention of prerequisites, typical use cases, or comparison with other describe-* tools in the sibling list.

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