Skip to main content
Glama
harness

Harness MCP Server

Official
by harness

harness_schema

Read-only

Fetches Harness YAML schemas and example snippets for resource types such as pipelines, templates, and connectors. Supports path drilling, keyword search, and scope-specific lookups.

Instructions

Fetch Harness YAML schema or examples for a resource type. Pipeline/template schemas are bundled from harness-schema; connector, environment, service, secret, and infrastructure schemas are fetched live from NG /yaml-schema (pass scope, org_id, project_id). release_process and release_activity schemas are fetched live from /gateway/rmg/api/yamlSchema. Use without path for a summary of fields and available sections. Use with path to drill into a specific section. Use with example to fetch a named example YAML snippet. Use with example_search to find examples by keyword. Precedence: example > example_search > path > summary. Available schemas: pipeline, template, trigger, pipeline_v1, template_v1, inputSet_v1, overlayInputSet_v1, agent-pipeline, connector, environment, service, secret, infrastructure, release_process, release_activity.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoDot-separated path to drill into a specific definition section. Omit for a top-level summary showing all available sections.
scopeNoHarness YAML scope for live entity schemas (connector, environment, service, secret, infrastructure, release_process, release_activity). Defaults to account. Org/project scoped entities require org_id and/or project_id.
org_idNoOrganization identifier — required when scope is org or project (live entity schemas).
exampleNoFetch a specific example by name (e.g. 'minimal-ci'). Returns the full YAML snippet and description.
identifierNoOptional entity identifier for NG yaml-schema. Use when updating an existing entity to fetch an entity-specific schema. Omit for generic create-time schemas — a placeholder identifier is sent automatically for all live entity types at any scope.
project_idNoProject identifier — required when scope is project (live entity schemas).
resource_typeNoSchema to fetch. Available: pipeline, template, trigger, pipeline_v1, template_v1, inputSet_v1, overlayInputSet_v1, agent-pipeline, connector, environment, service, secret, infrastructure, release_process, release_activity. Required for schema/path lookups, optional for example_search.
example_searchNoSearch examples by keyword. Returns matching example names and descriptions. Optionally combine with resource_type to filter.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv3.2.21
    • changedInput schema / properties / resource_type / description
      Previous value: -"Schema to fetch. Available: pipeline, template, trigger, pipeline_v1, template_v1, inputSet_v1, overlayInputSet_v1, agent-pipeline, connector, environment, service, secret, infrastructure. Required for schema/path lookups, optional for example_search."New value: +"Schema to fetch. Available: pipeline, template, trigger, pipeline_v1, template_v1, inputSet_v1, overlayInputSet_v1, agent-pipeline, connector, environment, service, secret, infrastructure, release_process, release_activity. Required for schema/path lookups, optional for example_search."
    • changedInput schema / properties / resource_type / enum
      Previous value: -[
      -  "pipeline",
      -  "template",
      -  "trigger",
      -  "pipeline_v1",
      -  "template_v1",
      -  "inputSet_v1",
      -  "overlayInputSet_v1",
      -  "agent-pipeline",
      -  "connector",
      -  "environment",
      -  "service",
      -  "secret",
      -  "infrastructure"
      -]New value: +[
      +  "pipeline",
      +  "template",
      +  "trigger",
      +  "pipeline_v1",
      +  "template_v1",
      +  "inputSet_v1",
      +  "overlayInputSet_v1",
      +  "agent-pipeline",
      +  "connector",
      +  "environment",
      +  "service",
      +  "secret",
      +  "infrastructure",
      +  "release_process",
      +  "release_activity"
      +]
    • changedInput schema / properties / scope / description
      Previous value: -"Harness YAML scope for live entity schemas (connector, environment, service, secret, infrastructure). Defaults to account. Org/project scoped entities require org_id and/or project_id."New value: +"Harness YAML scope for live entity schemas (connector, environment, service, secret, infrastructure, release_process, release_activity). Defaults to account. Org/project scoped entities require org_id and/or project_id."
  2. Changed1 schema field changedv3.2.16
    • addedInput schema / properties / identifier
      Added value: +{
      +  "description": "Optional entity identifier for NG yaml-schema. Use when updating an existing entity to fetch an entity-specific schema. Omit for generic create-time schemas — a placeholder identifier is sent automatically for all live entity types at any scope.",
      +  "type": "string"
      +}
  3. First observedv3.2.10

TDQS

A5/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true. The description adds rich behavioral context: which schemas are bundled vs live, required identifiers for certain scopes, automatic placeholder identifier behavior, and precedence rules. No contradiction with annotations.

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 comprehensive yet efficiently structured. It leads with the main purpose, then details usage modes, precedence, and resource list. Each sentence provides actionable guidance without redundancy.

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

Completeness5/5

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

Given the tool's complexity (8 parameters, no required fields, output schema present), the description covers all usage modes, parameter interactions, precedence, and lists all resource types. No gaps remain for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but the description adds significant meaning beyond field descriptions: explains the effect of omitting path, dot-separated path semantics, scope-dependent requirements, and the auto-placeholder identifier behavior. This exceeds the baseline for high-coverage schemas.

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?

The description clearly states it fetches Harness YAML schema or examples for a resource type. It differentiates bundled vs live schemas and lists all available resource types. This is specific and distinguishable from sibling CRUD tools.

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

Usage Guidelines5/5

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

Explicitly explains when to use without path, with path, with example, and with example_search, and defines precedence (example > example_search > path > summary). Also clarifies scope requirements for live schemas, giving unambiguous usage directions.

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