> For the complete documentation index, see [llms.txt](https://docs.pletor.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pletor.ai/automate/pletor-mcp.md).

# Pletor MCP

Connect Pletor to your favorite AI assistant in one click.

Once connected, you can discover workflows, run them, upload assets, and diagnose failures — all from a natural-language conversation.

Pletor MCP works with:

* **Claude** (Desktop, Web, Code)
* **Codex, Cursor**, **VS Code**, and any other MCP-compatible client

{% hint style="info" %}
**Before you start:** You'll need a Pletor account to use the Pletor MCP. See [Quickstart](/get-started/quickstart.md).

It takes a minute, and you'll connect your AI assistant to it in the next steps.
{% endhint %}

***

## Connect in 3 steps

{% stepper %}
{% step %}

### Open your AI assistant's connector settings

* **Claude** → [Customize](https://claude.ai/customize/connectors) → Connectors → *Add custom connector*

<figure><img src="/files/gCZoDRIpCGAKP0B08Xj0" alt=""><figcaption></figcaption></figure>

* **Cursor / VS Code** → MCP Servers → *Add server*
  {% endstep %}

{% step %}

### Add the Pletor MCP URL

Name the connector **Pletor** and paste this URL:

```
https://api.pletor.ai/mcp
```

{% endstep %}

{% step %}

### Sign in with your Pletor account

Click **Add** → **Connect**. You'll be redirected to log in with your existing Pletor account. Once authorized, the connector is ready.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
**Can't find "custom connectors"?** \
\
It's likely your organization does not currently allow for new connectors. Contact your workspace admin.
{% endhint %}

{% hint style="info" %}
**No API keys to manage.** Pletor MCP uses OAuth — your assistant signs in on your behalf and inherits your organization's permissions and credit balance.
{% endhint %}

***

## A complete workflow studio inside your AI assistant

### Discover workflows

Search your workflow library by name, tag, agent type, or visibility. Ask your assistant *"find a workflow for product photos"* and it will return the right match with its ID, description, and tags — ready to run.

### Run any workflow

Trigger a Pletor workflow asynchronously and get a run ID back immediately. Pass inputs as a plain object — your assistant maps natural-language requests onto the workflow's variables. Runs continue in the background while you keep chatting.

### Diagnose failures in one call

Ask *"why did my run fail?"* and `diagnose_run` returns a single flat report: the verdict, the failed node, the last successful node, an inputs summary, and a suggested next action. No more chaining three or four tool calls.

### Upload assets from anywhere on the web

Drop a public URL — image, video, audio, document — and Pletor ingests it as an asset you can reference in any workflow run. Set visibility to private, shared, or public.

### Browse models and pricing

List every available model with its capabilities, generation time, and credit cost.

### Search the docs

Get up-to-date guidance straight from `docs.pletor.ai`. Ask *"how do I structure inputs for the image-to-video node?"* and your assistant pulls the relevant excerpt and answers in-context.

***

## From idea to output in one conversation

### Marketing & content teams

*"Run my UGC ad workflow on this product photo and give me three variants."*\
Pletor uploads the asset, kicks off the workflow, and surfaces the generated creatives — all in chat.

### E-commerce

*"Generate lifestyle shots using the catalog template."*\
Search workflows by tag, run with the right inputs, and get the results without leaving your assistant.

### Agencies & freelancers

*"Show me every video workflow my team has built, then run the storyboard one on this brief."*\
Browse, pick, and execute across your whole library in seconds.

### Filmmakers & creators

*"Take this character reference and run the cinematic shot workflow with a sunset lighting prompt."*\
Upload, configure, and generate without touching the Pletor UI.

***

## Example prompts

### Discover

```
Find my workflows tagged "video"
```

```
List public workflows for the standard agent type
```

```
What image generation models do you support, and which are cheapest?
```

### Run

```
Run workflow abc-123 with prompt "a cat on a roof at golden hour"
```

```
Upload https://example.com/product.png and run my "lifestyle shot" workflow with it
```

```
Generate 3 variants of my UGC ad using this brief: [...]
```

***

## FAQ

<details>

<summary>How does Pletor connect to my AI assistant?</summary>

Pletor exposes an MCP (Model Context Protocol) server at `https://api.pletor.ai/mcp`. Any MCP-compatible client — Claude, Codex, Cursor, VS Code — can connect to it as a remote connector. Auth is handled via OAuth, so you sign in with your Pletor account and never copy-paste keys.

</details>

<details>

<summary>Which assistants are supported?</summary>

Any client that supports remote MCP servers: Claude (Desktop, Web, Code), Codex with MCPs, Cursor, VS Code, and others as the ecosystem grows.

</details>

<details>

<summary>What can I actually do with it?</summary>

Nine tools, grouped into four jobs:

* **Discover** — `search_workflows`, `list_models`, `search_pletor_docs`
* **Inspect** — `get_workflow_definition`
* **Run & monitor** — `run_workflow`, `get_flow_run_status`, `diagnose_run`, `get_node_run_result`
* **Provide inputs** — `upload_asset`

</details>

<details>

<summary>Do I need an API key?</summary>

No. Pletor MCP uses OAuth — log in once with your Pletor account and you're connected. Your assistant inherits your organization's workspace, workflows, and credit balance.

</details>

<details>

<summary>How does billing work?</summary>

Runs and uploads consume credits from your existing Pletor plan, just like the web app. Browsing workflows, inspecting definitions, and searching docs are free. There is no separate MCP subscription.

</details>

<details>

<summary>How long does a run take?</summary>

Runs are asynchronous. `run_workflow` returns a `flow_run_id` immediately; your assistant polls `diagnose_run` or `get_flow_run_status` until the run reaches `completed`, `failed`, or `canceled`. Duration depends on the workflow — single image nodes finish in seconds, multi-step video workflows can take minutes.

</details>

<details>

<summary>Can I run workflows I built in the Pletor app?</summary>

Yes. Every workflow in your organization — private, shared, or public — is visible through the MCP. The MCP is a remote control for your existing Pletor workspace, not a separate environment.

</details>

<details>

<summary>Can I upload files from my computer?</summary>

Today, `upload_asset` takes a public `source_url`. To upload local files, host them on any public URL (S3, Drive, Dropbox link, etc.) and pass that. Direct local-file ingestion is on the roadmap.

</details>

<details>

<summary>Is it secure?</summary>

Yes. OAuth tokens are scoped to your user and validated against Pletor's auth provider on every request. Tokens never leave your assistant; Pletor only receives the Bearer token the client sends. Asset visibility (`private` / `shared` / `public`) follows the same rules as in the Pletor web app.

</details>