Guides
Task-oriented workflows for setting up and operating Weavz.
Guides
Guides are practical workflows. Use them after you understand the core primitives or when you want to complete one setup task end to end.
Choose a path
| Goal | Start with | Then add |
|---|---|---|
| Build an AI-native SaaS agent surface | AI-Native SaaS Path | MCP Code Mode, Managing End Users, and Human Gates |
| Your backend calls one integration | Setting Up Connections | Executing Actions, then Input Partials for saved parameters |
| An AI client should use many workspace tools | Using Built-In Workspace Integrations | MCP Code Mode for broad workspaces, or MCP Tool Mode for a small tool set |
| Each customer user needs their own credentials | Managing End Users | per_user workspace integrations and MCP OAuth |
| Sensitive actions need review | Human Gates | API Keys with Human Gates decision permission for backend approvals |
| Workflows need files, state, browser control, or code | Using Built-In Workspace Integrations | Using Filesystem & State KV and Sandbox |
First-Day Setup
| Guide | Use it for |
|---|---|
| Setup Templates | Create a prepared workspace and OAuth MCP server from the dashboard |
| API Keys | Create org-scoped and workspace-scoped API keys |
| Setting Up Connections | Connect third-party services through hosted connect or direct credential APIs |
| Executing Actions | Run actions through dashboard, REST, SDKs, and workspace context |
| Using the Playground | Validate actions, triggers, MCP, partials, and approvals before launch |
Agent And Workflow Setup
| Guide | Use it for |
|---|---|
| Setting Up Triggers | Receive external events from integrations |
| Weavz MCP App | Connect Weavz directly inside Claude, ChatGPT, Codex, Cursor, and other remote MCP clients |
| MCP Code Mode | Give agents a compact code-driven MCP surface |
| MCP Tool Mode | Expose explicit action tools to MCP clients |
| Integration Aliases | Configure repeated integrations and MCP aliases |
| Managing End Users | Register users, generate connect URLs, and execute per-user actions |
Guardrails And Built-Ins
| Guide | Use it for |
|---|---|
| Using Input Partials | Save defaults and locked parameters |
| Human Gates | Require approval before sensitive execution |
| Using Built-In Workspace Integrations | Add Filesystem, State KV, HTTP, transformation, Sandbox, and memory tools |
| Using Filesystem & State KV | Store files and key-value data |
| Custom OAuth Apps | Register tenant-owned OAuth credentials from the dashboard |
| Activity Logs | Inspect execution and integration activity |