Skip to main content
Glama

Update Portfolio Schedule

update_portfolio_schedule
Idempotent

Replace the full definition of an owned report schedule using its current expected_revision. Preserve project_id from project_list when retaining project scope; omission or null selects portfolio scope. Pause with enabled=false; archive also disables, and restore paused. Editing an enabled schedule starts at its next future occurrence. Reuse the exact request_id and request for recovery; an exact retry returns the original receipt, so read current state afterward. Requires tickets:write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
definitionYes
request_idYes
schedule_idYes
expected_revisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / definition / properties / project_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "format": "uuid",
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Owned project UUID from project_list. Omit or pass null for a portfolio-wide schedule; project identity is frozen in each capture.",
      +  "title": "Project Id"
      +}
  2. Added

TDQS

A4.6/5.0
Behavior5/5

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

Adds substantial context beyond the annotations: exact request_id retry returns the original receipt, read state afterward, editing an enabled schedule reroutes to the next future occurrence, archived also disables, and the tickets:write permission requirement. These are real behavioral traits not derivable from readOnlyHint/idempotentHint alone.

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?

Front-loads the core action and packs scope, mutation states, scheduling, idempotency, and permission requirements into a tight paragraph with no filler sentences.

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?

For a mutation with a nested object, no output schema, and thin annotations, it covers permissions, idempotency, and lifecycle transitions well. The one remaining gap is run/scheduling outcome specifics (e.g. capture generation timing), but it explicitly tells the agent to read current state afterward, which mitigates this.

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?

With 0% schema description coverage, the description carries the load and does so well: it explains project_id scope semantics, expected_revision's role as a concurrency guard, request_id recovery behavior, and enabled/archived effects. It does not clarify hour/minute/frequency interactions against timezone, so it is strong but not exhaustive.

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 precise verb ('Replace') and resource ('the full definition of an owned report schedule'), immediately distinguishing it from create_portfolio_schedule, get_portfolio_schedule, and list siblings. The 'full definition' phrase signals replacement rather than partial patch semantics.

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?

Gives clear conditional guidance: use enabled=false to pause, archived to archive, preserve project_id for project scope vs omission/null for portfolio scope. It stops short of naming explicit alternatives (e.g. versus create_portfolio_schedule) but the branch conditions are actionable.

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