Skip to main content
Glama

Define program

define_program

Create a top-level program (a parallel workstream like Investor Relations or Partnerships, a peer of the built-in Revenue motion). applies_to lists the object keys it claims; membership_spec ({pipeline_keys?, stage_roles?, lifecycle_roles?, sub_status_roles?}) decides which records land in it. Programs are define-only from here: there is no update or archive verb for them yet (an admin edits them in Settings → Behavior; describe_schema lists them with their ids). Returns the created program.

When to use: When an admin runs a workstream alongside Revenue — Investor Relations, Partnerships — that should get its own lane.

Example: I'm also raising money — set up an Investor Relations program.

Input Schema

NameRequiredDescriptionDefault
labelYesDisplay name. Its slug becomes the program key, which can't be revenue or a built-in phase key (pre_sales, sales, customer_success).
applies_toYesObject keys this program can claim records of, e.g. ["investor"] or ["opportunity"]; at least one is required.
membership_specNo{pipeline_keys?, stage_roles?, lifecycle_roles?, sub_status_roles?}, string arrays; present dimensions must all match, absent = any. Default {} claims every applies_to record.

Output Schema

NameRequiredDescriptionDefault
programNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
  2. Changed4 schema fields changed
    • removedOutput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • removedOutput schema / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / program / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / program / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
  3. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already disclose mutation (readOnlyHint=false), non-destructive, non-idempotent, closed-world behavior. The description adds genuinely non-obvious context beyond that: the define-only lifecycle with no update/archive verb yet, and where edits must happen instead. It does not address duplicate-label behavior or key collisions beyond the schema's own note.

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 critical definition is front-loaded and the 'When to use' plus example are clearly separated. The opening sentence is long and dense with inline notation ({...}, applies_to), which slightly hurts scanability but no sentence is wasted.

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?

With an output schema present, the return value needn't be explained, and the annotations cover the safety profile. The description fills the remaining gaps on lifecycle, selection intent, and a worked example, leaving nothing an agent needs to call this correctly.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds conceptual meaning by explicitly relating the two key parameters: applies_to claims object keys while membership_spec decides which records land in the program. That division of responsibility is useful framing not obvious from the field list alone.

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+resource ('Create a top-level program') and immediately frames what a program is (a parallel workstream peer to the built-in Revenue motion). This cleanly distinguishes it from structural siblings like define_pipeline, define_object, and define_field, which also create top-level entities.

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?

Contains an explicit 'When to use' clause naming the triggering scenario (an admin running a workstream alongside Revenue) plus a concrete example. It also pre-empts misuse by stating programs are define-only and that an admin edits them in Settings, so an agent won't hunt for an update/archive verb.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources