From 12b73fcb3e45b17b013298edaa24cf6a69b04b7b Mon Sep 17 00:00:00 2001 From: Louis Choquel Date: Mon, 26 Oct 2026 16:43:07 +0100 Subject: [PATCH] Publish workshop-route, the get-started of pipelex-mcp, and retire mcp-route workshop-route.md is the rendering of the onboarding source's new assembly, which pipelex-mcp's README carries: it describes the repository as holding the Pipelex tools the plugin brings to a coding agent and sends chatbots to the Pipelex MCP in one line. mcp-route.md is removed, since no surface takes that assembly any more, and the note on whole get-started texts names workshop-route.md in its place. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01R6AgpTLGeUSbTGej9sFoN5 --- onboarding/README.md | 2 +- onboarding/rendered/mcp-route.md | 27 ----------------- onboarding/rendered/workshop-route.md | 43 +++++++++++++++++++++++++++ 3 files changed, 44 insertions(+), 28 deletions(-) delete mode 100644 onboarding/rendered/mcp-route.md create mode 100644 onboarding/rendered/workshop-route.md diff --git a/onboarding/README.md b/onboarding/README.md index a4dedf9..c4796d4 100644 --- a/onboarding/README.md +++ b/onboarding/README.md @@ -13,6 +13,6 @@ The files under `rendered/` are the onboarding text that Pipelex repositories, d ``` -A whole get-started text, such as `front-door.md` or `mcp-route.md`, opens with its own `##` heading. `api-key.md` has none: it is the sign-up line and the API-key step, and it sits inside a section of the page that carries it, where a starter, a template or an SDK lists what a reader needs. +A whole get-started text, such as `front-door.md` or `workshop-route.md`, opens with its own `##` heading. `api-key.md` has none: it is the sign-up line and the API-key step, and it sits inside a section of the page that carries it, where a starter, a template or an SDK lists what a reader needs. So an edit to one of those regions, or to a file here, is an edit the next generation overwrites. If something in it is wrong — a command that fails, a broken link, a step that does not work on your host — please [open an issue](https://github.com/Pipelex/.github/issues) and we will fix it at the source. That is the fastest route, and it fixes it everywhere at once rather than on the page you happened to be reading. diff --git a/onboarding/rendered/mcp-route.md b/onboarding/rendered/mcp-route.md deleted file mode 100644 index bdeb919..0000000 --- a/onboarding/rendered/mcp-route.md +++ /dev/null @@ -1,27 +0,0 @@ -## Get started - -Pipelex lets you build AI methods with your coding agent and run them anywhere: as an MCP for chatbots, as a webapp for people, or via API for your software. This repository is the Pipelex MCP: it connects your chatbot to your Pipelex account and the methods saved there. - -**Chatbots** — ChatGPT, Claude. Sign up at [app.pipelex.com](https://app.pipelex.com). Add the Pipelex MCP in your chatbot's settings by the address below — in Claude, that is **Add custom connector** — then sign in with your Pipelex account when asked. Nothing to install and no key: the Pipelex MCP runs on your signed-in session. - -``` -https://mcp.pipelex.com/mcp -``` - -**Coding agents** — Claude Code, Codex. Install the [Pipelex plugin](https://github.com/Pipelex/pipelex-plugins) instead: it brings the skills that build methods, and its own Pipelex tools, which run your methods and also work with the method files in your project. Claude Code also loads what you have added to your Claude account, so if you added the Pipelex MCP to Claude, Claude Code has it too. An agent with the plugin does not need the Pipelex MCP, and there is nothing to turn off: when both are present, the Pipelex MCP defers to the plugin's tools. - -**Then ask your chatbot:** - -> What methods do I have? -> -> Run github.com/Pipelex/methods/invoice_extraction@v0.1.1 on https://raw.githubusercontent.com/Pipelex/pipelex-cookbook/main/assets/extract_proof_of_purchase/restaurant_invoice.pdf - -You get a run id straight away, and you can ask for its status, its results or the files it produced at any time. - -Your new account comes with one method to try. A published method, such as those in the [Pipelex methods repository](https://github.com/Pipelex/methods), runs from its address with nothing to save. Your own methods come from the Pipelex plugin: build one in a coding agent and save it to your account, and your chatbot lists it and runs it by name. - -Give the file as a URL the Pipelex MCP can reach. In ChatGPT you can attach it to the conversation instead and ask for a run on it; Claude has no way yet to hand the Pipelex MCP a file you attached. - -Other hosts, and the reference for developers, start at [Which server, for which host](#which-server-for-which-host). - -**Next:** [what Pipelex is](https://go.pipelex.com/product) · [documentation](https://go.pipelex.com/docs) · [your console](https://app.pipelex.com) · [Discord](https://go.pipelex.com/discord) diff --git a/onboarding/rendered/workshop-route.md b/onboarding/rendered/workshop-route.md new file mode 100644 index 0000000..33208f0 --- /dev/null +++ b/onboarding/rendered/workshop-route.md @@ -0,0 +1,43 @@ +## Get started + +Pipelex lets you build AI methods with your coding agent and run them anywhere: as an MCP for chatbots, as a webapp for people, or via API for your software. This repository holds the Pipelex tools, which your coding agent gets with the Pipelex plugin: they run your methods and also work with the method files in your project. + +**1. Sign up at [app.pipelex.com](https://app.pipelex.com).** + +**2. Install the Pipelex plugin in your coding agent.** The plugin gives your agent the skills that build methods, run them and put them in your software, a hook that checks every edit, and the Pipelex tools. + +
Claude Code + +```bash +claude plugin marketplace add Pipelex/pipelex-plugins +claude plugin install pipelex@pipelex-plugins +``` + +Claude Code asks for an API key when you enable the plugin, and stores it in your OS keychain — create one in your console at [app.pipelex.com](https://app.pipelex.com). The skills, the hook that checks every edit and the Pipelex tools load with it. The plugin's hook and the Pipelex tools run on Node.js, so you need Node.js on your `PATH`. + +Claude Code also loads what you have added to your Claude account, so if you added the Pipelex MCP to Claude, Claude Code has it too. An agent with the plugin does not need the Pipelex MCP, and there is nothing to turn off: when both are present, the Pipelex MCP defers to the plugin's tools. + +
+ +
Codex + +```bash +codex plugin marketplace add Pipelex/pipelex-plugins +export PIPELEX_API_KEY=plx_sk_... # create one in your console at app.pipelex.com +``` + +Restart Codex, run `/plugins` to install `pipelex`, and trust the plugin hook on first run. Requires Codex 0.141 or later. The plugin's hook and the Pipelex tools run on Node.js, so you need Node.js on your `PATH`. + +
+ +**3. Ask your agent for the method you want.** + +> Design a method that reads an invoice PDF and returns the supplier, the total and the line items. Then run it on `~/Downloads/invoice.pdf` and save it to my Pipelex account. + +`/pipelex-design` writes the method, the hook checks it on every edit, `/pipelex-run` starts it and prints a run id you can come back to, and `/pipelex-catalog` saves it to your account, where your chatbot can run it too. + +**Chatbots** — ChatGPT, Claude — take the Pipelex MCP instead, a connector for chatbots that this repository does not hold: add it in your chatbot's settings by its address, `https://mcp.pipelex.com/mcp`. + +Other hosts, and the reference for developers, start at [Which server, for which host](#which-server-for-which-host). + +**Next:** [what Pipelex is](https://go.pipelex.com/product) · [documentation](https://go.pipelex.com/docs) · [your console](https://app.pipelex.com) · [Discord](https://go.pipelex.com/discord)