Skip to main content
Glama

ap_get_piece_props

ap_get_piece_props
Read-onlyIdempotent

Get the input schema for a piece action or trigger, plus AI guidance for using it: an AI-written description of what it does, an idempotency hint, and — when available — the output field paths it produces (for triggers, also derived from sample data). Use the AI description to pick the right action; when output fields are listed, reference them directly downstream as {{step['output'].path}}. Pass auth to resolve dynamic dropdowns and dynamic property sub-fields (e.g. Custom API Call url/body fields).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
authNoConnection externalId from ap_list_connections. When provided, dynamic dropdowns and dynamic property sub-fields are resolved via your account.
typeYesWhether to look up an action or a trigger.
inputNoKnown input values to resolve dependent dynamic properties.
flowIdNoFlow ID for resolving dependent dropdowns that need step context. Optional — most dropdowns work without it.
pieceNameYesThe piece name (e.g. "@activepieces/piece-slack"). Use ap_research_pieces to get valid values.
actionOrTriggerNameYesThe action or trigger name (e.g. "send_channel_message"). Use ap_research_pieces with pieceNames to get valid values.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already establish readOnly/idempotent/non-destructive/open-world, so the safety profile is covered. The description adds meaningful behavior beyond that: what is returned, that trigger output paths are derived from sample data, and that auth is required to resolve dynamic dropdowns and dynamic property sub-fields. It does not explain pagination or failure modes, but those are largely irrelevant for a schema lookup.

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?

Front-loads what is fetched, then the downstream usage, then the auth caveat. Two dense sentences with no filler, though the second sentence bundles several distinct behaviors and could be marginally tighter.

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?

No output schema exists, and the description compensates by describing the return payload (AI description, idempotency hint, output field paths) and how to consume it downstream. For a 6-parameter lookup tool with nested input objects, this is close to complete, missing only error/empty-result behavior.

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 description coverage is 100%, so every parameter is already documented with examples and cross-references. The description reinforces the auth-driven dynamic-resolution behavior, but adds little param syntax or format detail beyond the schema. Baseline 3 is appropriate when the schema does the heavy lifting.

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 ('Get the input schema for a piece action or trigger') and enumerates the additional payload (AI description, idempotency hint, output field paths). This clearly separates it from siblings like ap_search_actions and ap_research_pieces, which locate actions rather than describe one 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?

Gives real context: use the AI description to pick the right action, reference output fields downstream as {{step['output'].path}}, and pass auth to resolve dynamic dropdowns. It also points to ap_list_connections and ap_research_pieces for inputs. It stops short of explicit when-not-to-use or naming an alternative tool like ap_resolve_property_options.

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