Skip to main content
Glama

vbstudio_trigger_build

Start a VB Studio CI job or deploy pipeline step through the Builds REST API and get the build number back. Use it to run builds from a repo checkout with optional YAML parameters.

Instructions

Start a VB Studio CI job (also how you run a deploy job/pipeline step) via the documented Builds REST API. Returns the build number. The API base is derived from the repo's git remote. Credentials: VBSTUDIO_API_TOKEN, or VBSTUDIO_API_USERNAME/PASSWORD (falling back to the git credentials).

Input Schema

NameRequiredDescriptionDefault
repoNoRepo checkout to target: absolute path, or a repo name under VBS_WORKSPACE_DIR, or omit to use VBCS_REPO_PATH default. Use list_repos to see what's available on this instance.
jobNameYes
paramsYamlNoJob parameters as YAML (see vbstudio_job_params); omit for a job with none

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.3.2
    • removedInput schema / properties / appName
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / environment
      Removed value: -{
      -  "type": "string"
      -}
    • addedInput schema / properties / jobName
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / paramsYaml
      Added value: +{
      +  "description": "Job parameters as YAML (see vbstudio_job_params); omit for a job with none",
      +  "type": "string"
      +}
    • removedInput schema / properties / projectKey
      Removed value: -{
      -  "type": "string"
      -}
    • addedInput schema / properties / repo
      Added value: +{
      +  "description": "Repo checkout to target: absolute path, or a repo name under VBS_WORKSPACE_DIR, or omit to use VBCS_REPO_PATH default. Use list_repos to see what's available on this instance.",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "projectKey",
      -  "appName"
      -]New value: +[
      +  "jobName"
      +]
  2. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare the non-read-only, open-world, non-destructive profile, but the description goes further by stating the return value (the build number), the credential resolution chain (VBSTUDIO_API_TOKEN or username/password falling back to git credentials), and how the API base is derived from the git remote. These are operational details not present in the structured fields. It omits whether triggers are queued, deduplicated, or concurrent.

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?

Three dense sentences, front-loaded with the action and outcome, followed by environment/auth details. No filler and each sentence carries distinct information.

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

Completeness4/5

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

With no output schema, the description correctly states the return value (build number), covers authentication and API base derivation, and links to the parameter helper tool. The only gap is that the required jobName parameter's meaning and accepted values are never described.

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 coverage is 67%, so the schema documents repo and paramsYaml; the description reinforces the repo-to-git-remote relationship but adds no syntax for paramsYaml beyond pointing at vbstudio_job_params. The required jobName parameter carries no description in either schema or description, so the description does not fully compensate for the coverage gap. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Start a VB Studio CI job') and immediately clarifies the deploy/pipeline-step use case, which separates it from siblings like vbstudio_build_status (status polling) and vbstudio_job_params (parameter discovery). An agent can identify the operation without opening the schema.

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

Usage Guidelines4/5

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

The parenthetical 'also how you run a deploy job/pipeline step' tells the agent this tool covers both CI and deploy triggers, and it points to vbstudio_job_params for parameter construction. It stops short of explicit when-not-to-use or a direct comparison with run_build, so it is clear context but not full routing guidance.

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