Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 23:30 UTC
docs: add proxy execute usage guide (SEC-351) (#3261)
## Summary Adds a dedicated "Proxy execute" guide to the Guides section of the docs, based on [SEC-351](https://linear.app/composio/issue/SEC-351/docs-write-proxy-execute-usage-guide-with-real-customer-use-cases). The guide documents how customers should use `composio.tools.proxy()` / `composio.tools.proxyExecute()` to call toolkit APIs directly while letting Composio inject credentials. It pulls structure and tone from [Managing multiple connected accounts](https://docs.composio.dev/docs/managing-multiple-connected-accounts) and uses the real customer use cases captured in the Linear ticket (deepleap — LinkedIn, swix.ai — Google/Microsoft, Mally — terminal/CLI agent). Fixes SEC-351. ## Changes - New page `docs/content/docs/proxy-execute.mdx` covering: - What proxy execute is and when to reach for it (callout linking to [Sessions vs direct execution](https://docs.composio.dev/docs/sessions-vs-direct-execution)). - Three customer use cases with paired Python + TypeScript snippets. - Quick start. - Parameter reference table (including `binary_body`) mirroring [POST /api/v3.1/tools/execute/proxy](https://docs.composio.dev/reference/api-reference/tools/postToolsExecuteProxy). - Response shape. - Common patterns: GET with query params, POST with JSON body, custom headers, and a cURL upload example. - Error handling table and matching Python + TypeScript snippets for 401 / 403 / 429 / 400. - "When not to use proxy execute" and a "What to read next" `<Cards>` block. - `llmGuardrails: "direct-execution"` frontmatter, since proxy execute is a direct-execution API (consistent with `tools-direct/*` pages). - Adds `"proxy-execute"` to the Guides section in `docs/content/docs/meta.json` so the page shows up in the sidebar next to the other guides. ## Type of change - [ ] Bug fix - [ ] New feature - [ ] Refactor/Chore - [x] Documentation - [ ] Breaking change ## How Has This Been Tested? - `bun install && bun run build` in `docs/` — build succeeds (all 1377 static pages generated, no twoslash / MDX errors). - Visually reviewed the new page in isolation; all internal links (`/docs/...`, `/reference/api-reference/tools/postToolsExecuteProxy`, `/docs/changelog/2025/12/30`) are relative per `docs/CLAUDE.md` rule 10. - `bun run scripts/validate-links.ts` hits a pre-existing Bun `fs.glob` env issue unrelated to this change; CI runs the authoritative link check. ## Screenshots (if applicable) N/A — text-only docs change. ## Checklist - [x] I have read the Code of Conduct and this PR adheres to it - [x] I ran linters/tests locally and they passed - [x] I updated documentation as needed - [x] I added tests or explain why not applicable (docs-only change) - [x] I added a changeset if this change affects published packages (N/A — docs only) ## Additional context Docs branches target `next`, not `master`, per `docs/CLAUDE.md`. Link to Devin session: https://app.devin.ai/sessions/d23f9b9d567c43d4b5e6b3e7234df7f5 Requested by: @palash-c
No changes.