For the complete documentation index, see llms.txt. This page is also available as Markdown.

Default tools for the hosted Patchworks MCP server

Introduction

The hosted Patchworks MCP server includes a default set of tools that are ready to use. These tools are summarised here, in the following categories:

Flow management

Tool
Summary

get_all_flows

List flows from the Core API.

get_flow_runs

Query flow runs (filter by status; started_after; sort; includes).

get_flow_run_logs

Retrieve logs for a specific flow run (optionally with payload IDs).

start_flow

Trigger a flow run via the Start service (/flows/{id}/start).

Data pools

Tool
Summary

list_data_pools

List all data (dedupe) pools.

get_deduped_data

Retrieve deduplicated data for a specific pool.

Marketplace

Tool
Summary

get_marketplace_apps

List marketplace blueprints from the Patchworks marketplace.

get_marketplace_app

Get details of a specific marketplace blueprint by ID.

Troubleshooting

Tool
Summary

summarise_failed_run

Summarise what went wrong in a failed run.

triage_latest_failures

Fetch recent failed runs and return a compact summary.

download_payload

Download payload bytes for a given payload metadata ID (base64).

Utility

Tool
Summary

example_get_all_flows

Example demonstrating tool definition patterns.

list_tools

List all available tools in this MCP server.

Agent conversations

These tools provide low-level access to the Patchworks agent conversation API. They can be used to start and continue a conversation with any platform agent directly. For purpose-built wrappers with clearer parameter guidance, see Platform agents below.

Tool
Summary

list_agent_conversations

List all agent conversations (paginated).

create_agent_conversation

Create a new agent conversation for a given feature (assistant, implementation-agent, connector-builder, flow-builder, map-builder, answers-agent, documentation-agent or health-monitor).

get_agent_conversation

Get a specific agent conversation by ID.

reply_to_agent_conversation

Send a follow-up message to an existing agent conversation.

create_agent_conversation parameters

Parameter
Type
Required
Description

feature

string

Yes

The platform agent to start a conversation with. One of the feature values listed below.

prompt

string

Yes

The initial message to send to the agent.

payload

object

No

Feature-specific context (for example, the flow or step the agent should work on). See the reference below.

create_agent_conversation feature and payload reference

Feature
What it does
Payload fields

assistant

General Patchworks assistant for questions and guidance about the platform.

None — pass {} or omit.

implementation-agent

Builds new integrations end to end, including creating new flows. Use this when you need a flow that doesn't exist yet.

None — pass {} or omit.

connector-builder

Builds a new connector, or continues work on an existing one.

connector_id (int, optional) — pass to continue building an existing connector; omit to create a new one.

flow-builder

Edits a single existing flow.

flow_id (int, required). The flow builder only edits existing flows — to create a new flow, use implementation-agent instead.

map-builder

Builds or edits the field mapping for a specific map step in a flow.

flow_step_id (int, required), flow_version_id (int, optional), flow_id (int, optional).

answers-agent

Answers questions about your integrations and data.

None — pass {} or omit.

documentation-agent

Generates documentation, optionally scoped to a specific flow.

flow_id (int, optional) — pass to document a specific flow.

health-monitor

Investigates the health of a flow or a specific flow run and helps diagnose problems.

flow_run_id (string, optional), flow_id (int, optional) — pass either to focus the agent on a particular run or flow.

Once a conversation is created, use reply_to_agent_conversation to continue it with follow-up messages, and get_agent_conversation to retrieve its current state.

Last updated

Was this helpful?