Skip to main content
Glama

Get Action Knowledge

get_pica_action_knowledge

Retrieve comprehensive documentation for an action including parameters, requirements, and usage examples. Must be called before executing the action to understand its requirements and ensure correct usage.

Instructions

Get comprehensive documentation for a specific action including parameters, requirements, and usage examples. MANDATORY: You MUST call this tool before execute_pica_action to understand the action's requirements, parameter structure, caveats, and proper usage. This loads the action documentation into context and is required for successful execution.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
action_idYesThe action ID to get knowledge for (from the actions list returned by get_pica_platform_actions). REQUIRED: This tool must be called before create_pica_request to load the action's documentation into context.
platformYesThe platform name to get knowledge for (e.g., 'ship-station', 'shopify'). This is the kebab-case version of the platform name that comes from the list_pica_integrations tool AVAILABLE PLATFORMS section.
Behavior4/5

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

No annotations provided, but description accurately conveys it's a read operation that loads documentation into context. It does not disclose any side effects, but given the read-only nature, this is sufficiently transparent.

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?

Description is front-loaded with purpose, followed by mandatory usage instruction. Each sentence adds value, though could be slightly more concise. No fluff.

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, but description states it provides 'comprehensive documentation' which sufficiently covers return value. For a 2-param tool with no nested objects, the description is complete enough.

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%. The description adds value by explaining that action_id comes from get_pica_platform_actions and platform is kebab-case from list_pica_integrations, providing integration context beyond schema descriptions.

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 'Get comprehensive documentation for a specific action', using a specific verb and resource. It distinguishes from siblings (execute, list actions, list integrations) by focusing on documentation retrieval and mandatory pre-execution role.

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 instructs 'You MUST call this tool before execute_pica_action' and states it is required before create_pica_request, providing clear when-to-use guidance and rationale.

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/mcp-research/picahq__mcp'

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