
What the Plan Agent Does
When you provide a prompt, the agent will automatically:- Identify Systems: It detects the source and target platforms involved in the integration and selects the appropriate connectors.
- Research APIs: The agent searches documentation to find auth methods, API endpoints, webhooks or triggers, required fields/ request formats, query patterns and pagination rules.
- Understand Data Models: It analyses the objects and fields used by each system so it can recommend mappings between them.
- Defines Workflows: The agent determines how the integration should run, including triggers, actions, retries, and idempotency requirements.
- Surface Implementation Details: It highlights important constraints such as API rate limits, webhook response requirements, auth flows and missing entities or required workarounds.
Tips For Prompting the Plan Agent
The quality of the research depends on the detail in your prompt. The more context you provide, the more precise the integration plan will be. A strong prompt usually includes:- Systems Involved: Clearly state the platforms you want to connect.
- Workflow Trigger: Describe what event starts the workflow or how frequent a workflow should run on a schedule.
- The Action: Explain what the integration should do.
- How Records Should Be Mapped: If records already exist, explain how they should be found.
- Edge Cases or Business Rules: Mention anything the agent should account for.
- Authentication Requirements: If known, specify how each system should authenticate.
- Documentation: Provide relevant links to each systems API documentation and its endpoints.
- Variability (Multi Tenanted Integrations): What configuration is dynamic per each end user of the integration.
- Transformation Mappings: Provide any known transformation requirements that the integration should follow.
Plan Agent Prompt Example
What the Plan Agent Produces
Once the research completes, the agent generates a structured integration plan. This typically includes:- Connector Identification: The platforms involved in the integration.
- Authentication Requirements: How each system must be authenticated.
- API Endpoints: Relevant endpoints for creating, updating, or querying data.
- Field Mappings: Suggested mappings between source and target data models.
- Workflow Design: Triggers, actions, and conditions required to run the integration.
- Implementation Considerations: Important details such as webhook verification, retry logic, rate limits, required fields and entity limitations.
What to do Next
Once the plan looks correct:- Review the Research Output: to confirm the systems and workflow match your requirements.
- Check the Field Mappings: and ensure they align with your data model.
- Adjust the Prompt: if you need the agent to refine the plan.
- Move on to the Connect Step: to configure authentication and establish the system connections.