Skip to main content
Glama
kuklaph
by kuklaph

Read Workflow Settings

cascade_read_workflow_settings
Read-onlyIdempotent

Read workflow settings for a Cascade container to check available workflow definitions, whether workflow is required, and inheritance before editing policy.

Instructions

Read workflow settings for a Cascade container (folder or site).

Returns which workflow definitions are available on the container, whether workflow is required for changes inside it, whether children inherit the setting, and the step/action configuration. Workflow settings apply to containers only — if you query a non-container, Cascade returns an error. Use this before editing workflow policy so you know the existing configuration.

Args:

  • identifier (object, required): The container

    • id (string, optional): Container ID (preferred)

    • path (object, optional): { path, siteId OR siteName }

    • type (string, required): Typically "folder" or "site"

Returns: Cascade OperationResult: { success: true, workflowSettings: { identifier: { ... }, workflowDefinitions: [ ... ], inheritedWorkflowDefinitions: [ ... ], inheritWorkflows: boolean, requireWorkflow: boolean } } On failure: { success: false, message: "" }

Examples:

  • Use when: "Does /about require workflow?" -> { identifier: { type: "folder", path: { path: "/about", siteName: "www" } } }

  • Use when: "Read a site's workflow policy" -> { identifier: { type: "site", id: "..." } }

  • Don't use when: You want to inspect an in-flight workflow — use cascade_read_workflow_information.

  • Don't use when: Target is not a container — workflow settings are container-only.

Error Handling:

  • "Asset not found" when the identifier doesn't resolve

  • "Not a container" when type is not folder/site/similar

  • "Permission denied" when credentials lack read access. Responses are JSON text; structuredContent is authoritative when the response fits. Oversized responses return bounded _cache metadata for cascade_read_response. For cascade_read, read_mode controls preview versus raw Cascade payload shape.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
identifierNoThe folder whose workflow settings to read.
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true. The description adds context: error messages ('Asset not found', 'Not a container', 'Permission denied'), response format (JSON text, structuredContent authority, oversized responses with _cache metadata), and that workflow settings apply only to containers. This supplements the annotations effectively.

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?

Well-organized into sections: purpose, args, returns, examples, don't use, error handling. Every section adds value. A few boilerplate sentences about response handling are slightly lengthy but not detrimental. Overall efficient for the tool's complexity.

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 has one parameter and no output schema, the description is highly comprehensive. It details the return structure, error cases, usage scenarios, and mentions inheritance behavior. It also references sibling tools, making the context complete for an AI agent.

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% for the single identifier parameter. The description goes beyond: explains the param is a container (folder/site), provides structure for id and path (with siteId or siteName), and gives examples. This adds significant meaning not present in the schema 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?

The description clearly states 'Read workflow settings for a Cascade container (folder or site).' It specifies the verb (read) and resource (workflow settings of a container). It distinguishes from sibling tools like cascade_read_workflow_information and cascade_edit_workflow_settings by clarifying scope and usage.

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?

Provides explicit 'Use when' and 'Don't use when' sections with concrete examples, such as 'Does /about require workflow?' and mentions alternatives like cascade_read_workflow_information for in-flight workflows. It also warns against querying non-containers.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/kuklaph/cascade-cms-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server