Skip to main content
Glama

track_deployment

Records deployment events in ServiceNow, linking each execution to its pipeline step and target environment for audit trails and deployment velocity tracking.

Instructions

Record a deployment event in ServiceNow (a DevOps task execution, linked to the pipeline deploy step and environment when they exist) for audit and velocity tracking. [Write]

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "environment": "<environment>",
      "artifact_name": "<artifact_name>",
      "status": "<status>"
    },
    "name": "track_deployment"
  }
}

Input Schema

NameRequiredDescriptionDefault
notesNoDeployment notes
statusYesDeployment status: success, failed, rolled_back
pipelineNoPipeline sys_id or name
environmentYesTarget environment
artifact_nameYesArtifact or application name
execution_urlNoOptional link to the pipeline run (CI/CD job URL)
artifact_versionNoVersion or build number

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.0.1
    • addedInput schema / properties / execution_url
      Added value: +{
      +  "description": "Optional link to the pipeline run (CI/CD job URL)",
      +  "type": "string"
      +}
  2. First observedv1.0.2

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description adds real context beyond that by explaining that a DevOps task execution is created and that pipeline/environment linkage is applied 'when they exist' (conditional behavior). It does not address duplicate handling, required field failures, or permissions, which matters for a non-idempotent write.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The definition is a single front-loaded sentence with the action and destination stated first, followed by the record semantics and purpose. The trailing '**[Write]**' marker is redundant with the supplied annotations but is short enough not to harm readability.

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

Completeness3/5

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

With seven parameters, full schema coverage, and annotations present, the definition covers enough to invoke the tool correctly. The notable gap is the absence of any output schema combined with no statement of what is returned (e.g., the created task execution's sys_id or URL), which an agent would plausibly need after recording a deployment.

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 already explains all seven parameters, making 3 the baseline. The description contributes a small amount of extra meaning by framing pipeline and environment as optional linkage targets on the created record, but adds no format or allowed-value detail beyond the schema's 'success, failed, rolled_back' status note.

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 states a concrete verb and resource: 'Record a deployment event in ServiceNow', and clarifies that this materializes as a DevOps task execution linked to the pipeline deploy step. It is clearly a creation/write tool distinct from read-oriented siblings like get_deployment or list_deployment_history, but it never names or contrasts those siblings explicitly.

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

Usage Guidelines3/5

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

The stated motivation ('for audit and velocity tracking') implies the tool is used after a deploy completes, which gives some contextual placement. However, there is no explicit when-to-use versus when-not guidance and no routing away from adjacent tools such as rollback_deployment or validate_deployment.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools