Skip to main content
Glama

Plan an integration

plan_integration
Read-onlyIdempotent

Integrations (between two systems): Use when someone wants to set up a sync between two systems, for example "when a deal is won in our CRM, make a draft invoice in our accounting system" or "keep our customers and invoices the same in both systems". It checks the plan against what CRM Connector offers and returns the record types that will travel, in which direction, plus a link that opens the setup wizard prefilled, where the person signs in, connects both systems and reviews everything before anything syncs. It plans one way unless direction is both_ways; then every chosen record type the pair can carry back travels both ways, and the answer names what stays one way and why. Call find_sync_options first when you do not know which record types a pair offers or which travel both ways. Not for questions about what is possible (use find_sync_options) or for a person's own integrations; nothing is created by this tool: the person finishes the setup in CRM Connector.

Input Schema

NameRequiredDescriptionDefault
triggerNoOptional moment a record must reach before it travels, for example paid or overdue (invoices) or accepted (quotes). It applies to every chosen record type that can wait for it; the others travel when created.
directionNoOptional: one_way (the default) copies records from the source into the target; both_ways also sends changes made in the target back, for every chosen record type the pair carries both ways (find_sync_options marks them). Choose both_ways only when the person wants changes to flow back. Record types that cannot travel both ways stay one way, and the answer says which.one_way
record_typesYesWhat should travel, at least one, by the keys find_sync_options returns: "invoice" copies invoices, "deal_to_invoice" turns won deals into draft invoices. Contacts are always added when the pair carries them.
source_systemYesThe system records come from, by its key.
target_systemYesThe system records go into, by its key.

Output Schema

NameRequiredDescriptionDefault
notesYes
sheetYes
sourceYes
targetYes
outcomeYes
summaryYes
directionYes
wizardUrlYes
notIncludedYes
recordTypesYes
requestIntegrationUrlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the readOnlyHint/idempotent annotations it discloses the crucial behavior that 'nothing is created by this tool' and that the person signs in, connects and reviews before anything syncs. It also explains the asymmetric both_ways outcome and that the answer names which record types stay one way and why.

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-loaded with the use case and constraints before the mechanics, and nearly every sentence earns its place. There is mild duplication: the one-way/both_ways behavior is restated in the description and again in the direction parameter schema, costing a little tightness.

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?

For a 5-parameter planning tool with an output schema, the description covers the input intent, the no-side-effect contract, the prerequisite workflow, and the shape of the result (what travels, which direction, prefilled link). An agent has everything needed to call it and set expectations.

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%, so baseline is 3; the description adds real meaning by stating the default is one-way and that both_ways only applies to record types the pair actually carries both ways, with leftovers reported in the answer. It does not add anything about source_system/target_system keys beyond the enum, and trigger semantics are left to the schema.

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+resource ('Integrations between two systems' / 'It plans...') and concretely describes the artifacts produced: record types that travel, direction, and a prefilled wizard link. It explicitly distinguishes itself from find_sync_options and list_integrations, so an agent can route between siblings without opening schemas.

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?

Gives explicit when-to-use examples ('when a deal is won in our CRM, make a draft invoice...'), a prerequisite ('Call find_sync_options first when you do not know which record types a pair offers'), and explicit exclusions ('Not for questions about what is possible... or for a person's own integrations'). This is textbook when/when-not/alternatives coverage.

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