Skip to content

Commit 3b446bf

Browse files
docs: fix decopilot tool names, concepts entities, monitoring scope, API keys
- Fix decopilot tool names: tool_search/tool_enable removed (not real tools), subtask_run → subtask, resource_read → read_resource, prompt_read → read_prompt - Add missing tools: sandbox, read_tool_output, propose_plan - Add subtask restrictions: 15 step limit, must return summary - Fix task status: "Success" → "completed" with actual enum values - Update concepts: agents/projects share subtype field, add Thread, Event Bus, Tags, AI Provider Keys - Clarify monitoring scope: only MCP proxy calls logged, not management API - Fix API keys: remove Settings UI references, document permission format - All fixes applied to both EN and PT-BR Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ccf9d83 commit 3b446bf

12 files changed

Lines changed: 88 additions & 80 deletions

File tree

apps/docs/client/src/content/deco-studio/en/studio/api-keys.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,14 @@ API keys let external systems connect to deco Studio without needing a user to l
2828

2929
## Creating an API Key
3030

31-
1. Open the **deco Studio Dashboard**
32-
2. Go to **Settings****API Keys**
33-
3. Click **Create API Key**
34-
4. Give it a name (like "My Automation Script")
35-
5. Assign [roles and permissions](/en/studio/user-management)
36-
6. **Copy the key immediately**
31+
API keys are managed through the management MCP tools or the API. When creating an API key, you specify:
32+
33+
1. A descriptive name (like "My Automation Script")
34+
2. Direct permissions in the format `{ resource: [actions...] }` — where the resource is either `"self"` for management tools or `"conn_<UUID>"` for connection-specific access
35+
3. **Copy the key immediately** — it is only shown once
3736

3837
<Callout type="error">
39-
You can only see the API key once. Copy it now and store it somewhere safe like a password manager.
38+
You can only see the API key once. Store it somewhere safe like a password manager.
4039
</Callout>
4140

4241
## Using Your API Key

apps/docs/client/src/content/deco-studio/en/studio/concepts.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,18 @@ icon: BookOpen
99
- **Organization**: the top-level tenant boundary. Everything (connections, agents, projects, logs) is org-scoped.
1010
- **Members**: users invited into an organization with specific roles and permissions.
1111
- **Connection**: a configured upstream MCP endpoint (usually HTTP), optionally with stored credentials. See [Connections](/en/studio/connections).
12-
- **Virtual MCP**: aggregates tools/resources/prompts from connected servers into a single MCP. See [Virtual MCPs](/en/studio/virtual-mcps).
13-
- **Agent**: single-purpose Virtual MCPs optimized for specific tasks. See [Agents](/en/studio/agents).
12+
- **Virtual MCP**: aggregates tools/resources/prompts from connected servers into a single MCP. Agents and Projects are both Virtual MCPs distinguished by a `subtype` field. See [Virtual MCPs](/en/studio/virtual-mcps).
13+
- **Agent**: a Virtual MCP with subtype `agent` — focused on specific tasks with a curated toolset. See [Agents](/en/studio/agents).
14+
- **Project**: a Virtual MCP with subtype `project` — organizes project-specific tools, resources, prompts, and config. See [Projects](/en/studio/projects).
1415
- **Automation**: unattended agent runs on a schedule or event trigger. See [Automations](/en/studio/automations).
15-
- **Project**: Virtual MCPs to organize project-specific tools, resources, prompts, and config. See [Projects](/en/studio/projects).
16+
- **Thread**: a persistent conversation session with an agent. Stores chat messages and tracks status (`in_progress`, `requires_action`, `completed`, `failed`).
17+
- **Event Bus**: pub/sub system between connections following CloudEvents v1.0 spec. Supports scheduled delivery, cron-based recurring events, and at-least-once delivery guarantees.
18+
- **Tags**: organization-level labels for categorizing and filtering members.
19+
- **AI Provider Keys**: API key management for AI model providers (e.g. OpenRouter).
1620

1721
## Understanding Agents vs. Projects
1822

19-
Both agents and projects are Virtual MCPs, but they serve different purposes in your workflow:
23+
Both agents and projects are Virtual MCPs stored in the same `connections` table, distinguished by a `subtype` field (`agent` or `project`). They serve different purposes in your workflow:
2024

2125
**Projects** are general-purpose organizational units for ongoing work:
2226
- **Broad scope** - Cover multiple workflows and capabilities within a work context
@@ -32,7 +36,7 @@ Both agents and projects are Virtual MCPs, but they serve different purposes in
3236
- **Example** - "Refund Processing Agent" that only handles customer refunds and return authorizations
3337
- **When to use** - Focused operations, built-in mesh management, or specialized workflows
3438

35-
Both follow the same Virtual MCP architecture, but their design principles differ: projects organize capabilities for broad work contexts, while agents are reusable configurations that can be instantiated on-demand with fresh execution state.
39+
Both share the same Virtual MCP architecture and storage model, but their design principles differ: projects organize capabilities for broad work contexts, while agents are reusable configurations that can be instantiated on-demand with fresh execution state.
3640

3741
## MCP Protocol Primitives
3842

apps/docs/client/src/content/deco-studio/en/studio/decopilot/context.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ See [Agents](/en/studio/agents) for more on how agents provide fresh, focused co
116116

117117
## How Scopes Affect Context
118118

119-
Each [scope](/en/studio/decopilot/scopes) has access only to its own tools and resources. When you switch scopes, the tools available through `tool_search` change to match that scope's virtual MCP, and the instructions that load into the scope instructions slot change—organization, project, or agent-specific. See [Scopes](/en/studio/decopilot/scopes) for details.
119+
Each [scope](/en/studio/decopilot/scopes) has access only to its own tools and resources. When you switch scopes, the tools available through the scope's tools change to match that scope's virtual MCP, and the instructions that load into the scope instructions slot change—organization, project, or agent-specific. See [Scopes](/en/studio/decopilot/scopes) for details.
120120

121121
## Practical Tips
122122

apps/docs/client/src/content/deco-studio/en/studio/decopilot/tasks-and-spawning.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ Tasks move through different states as work progresses. Understanding these stat
3131

3232
Every task has one of four statuses:
3333

34-
- **In Progress** - Active work happening, agent is executing or waiting for next message
35-
- **Requires Action** - Paused, waiting for your input (tool approval or question response)
36-
- **Success** - Work completed successfully
37-
- **Failed** - Something went wrong or task timed out
34+
- **In Progress** (`in_progress`) - Active work happening, agent is executing or waiting for next message
35+
- **Requires Action** (`requires_action`) - Paused, waiting for your input (tool approval or question response)
36+
- **Completed** (`completed`) - Work completed successfully
37+
- **Failed** (`failed`) - Something went wrong or task timed out
3838

3939
### When Tasks Require Attention
4040

@@ -77,7 +77,7 @@ This makes subtasks perfect for intensive work that would otherwise fill up your
7777
When you spawn a subtask:
7878

7979
1. **Fresh start** - Subtask begins with clean context (just scope instructions and system prompt)
80-
2. **Independent execution** - Subtask is a regular task with restricted built-in tools (no `subtask_run` or `user_ask`)
80+
2. **Independent execution** - Subtask is a regular task with restricted built-in tools (no `subtask` or `user_ask`)
8181
3. **Summary return** - Parent task receives only a concise summary (200-500 tokens)
8282
4. **Full details preserved** - Complete subtask conversation saved in task history
8383

@@ -88,7 +88,7 @@ The parent task sees just the summary—keeping your main conversation lean—wh
8888
| Feature | Main Task | Subtask |
8989
|---------|-----------|---------|
9090
| Context | Accumulated history | Fresh, clean start |
91-
| Available tools | All built-in tools + current scope's tools | Same, but no `subtask_run` or `user_ask` |
91+
| Available tools | All built-in tools + current scope's tools | Same, but no `subtask` or `user_ask` |
9292
| Result visibility | Full conversation | Summary only to parent |
9393
| User interaction | Can ask questions (`user_ask`) | Cannot ask questions |
9494

apps/docs/client/src/content/deco-studio/en/studio/decopilot/tools.mdx

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import Callout from "../../../../../components/ui/Callout.astro";
1212

1313
## Overview
1414

15-
Decopilot uses two types of tools: **built-in tools** for discovering capabilities and managing work, and **scope tools** from the current [scope](/en/studio/decopilot/scopes) for domain-specific actions. Tools are discovered with `tool_search` and activated on-demand with `tool_enable`, keeping execution focused and preventing tool overload.
15+
Decopilot uses two types of tools: **built-in tools** for discovering capabilities and managing work, and **scope tools** from the current [scope](/en/studio/decopilot/scopes) for domain-specific actions. Scope tools are available based on the connections in the current scope's Virtual MCP — decopilot sees them listed in its system prompt.
1616

1717
## Tool Reference
1818

@@ -23,19 +23,20 @@ All built-in tools are available across all scopes. Availability varies between
2323
| Tool | Task | Subtask | Description |
2424
|------|:----:|:-------:|-------------|
2525
| **Discovery** |
26-
| `tool_search` ||| Search for tools in current scope |
27-
| `tool_enable` ||| Activate a tool for use in current task |
2826
| `agent_search` ||| Find agents configured in the organization |
2927
| **Execution** |
30-
| `subtask_run` ||| Spawn subtask with fresh context, optionally specifying an agent |
28+
| `subtask` ||| Spawn subtask with fresh context, optionally specifying an agent |
3129
| `user_ask` ||| Ask user for input or clarification |
30+
| `sandbox` ||| Execute JavaScript code with access to MCP tools |
3231
| **Context** |
33-
| `resource_read` ||| Read documentation/guidelines from current scope (supports line ranges) |
34-
| `prompt_read` ||| Read prompt templates from current scope |
32+
| `read_resource` ||| Read documentation/guidelines from current scope (supports line ranges) |
33+
| `read_prompt` ||| Read prompt templates from current scope |
34+
| `read_tool_output` ||| Filter large tool outputs using regex patterns |
35+
| `propose_plan` ||| Propose execution plans for user approval (in "plan" approval mode) |
3536

3637
### Scope Tools
3738

38-
Scope tools come from the current scope—domain-specific capabilities like Shopify, inventory systems, or shipping tools. These are discovered via `tool_search` and enabled via `tool_enable`.
39+
Scope tools come from the current scope—domain-specific capabilities like Shopify, inventory systems, or shipping tools. These are available based on the connections configured in the scope's Virtual MCP.
3940

4041
**Example**: A project with Shopify and ShipStation connections might expose:
4142
- `GET_ORDERS` - Fetch customer orders
@@ -65,44 +66,44 @@ These annotations allow decopilot to respect tool constraints automatically. For
6566
**Subtasks** are spawned by decopilot for parallel work, specialized execution, or isolated context. They have restricted access:
6667
- **Cannot spawn additional subtasks** - Prevents infinite delegation
6768
- **Cannot ask user questions** - Subtasks run autonomously without blocking
69+
- **Step limit of 15** (vs parent's 30) - Ensures subtasks stay focused
70+
- **Must return a summary** - Results flow back to the parent task
6871

6972
These restrictions ensure subtasks complete independently and don't create blocking dependencies.
7073

7174
## Tool Discovery Flow
7275

7376
Decopilot starts each task with only built-in tools, then discovers and enables capabilities as needed:
7477

75-
1. **Explore** - Use `tool_search` to see what's available in the current scope
76-
2. **Enable** - Use `tool_enable` to activate specific tools for the task
77-
3. **Execute** - Use enabled tools to accomplish work
78-
4. **Delegate** - Spawn subtasks via `subtask_run` for parallel or specialized work
79-
80-
This discover-and-enable pattern ensures decopilot deliberately chooses its toolset rather than being overwhelmed by every available capability.
78+
1. **Explore** - Scope tools are listed in the system prompt based on the current Virtual MCP
79+
2. **Execute** - Use available tools to accomplish work
80+
3. **Delegate** - Spawn subtasks via `subtask` for parallel or specialized work
81+
4. **Read context** - Use `read_resource` and `read_prompt` to load domain knowledge
8182

8283
## Common Workflows
8384

84-
### Discover-Enable-Execute
85+
### Execute Scope Tools
8586

8687
The most common pattern for using scope tools:
8788

88-
1. Search for capabilities with `tool_search`
89-
2. Enable specific tools with `tool_enable`
90-
3. Use enabled tools to accomplish work
89+
1. Review available tools from the current scope
90+
2. Use tools to accomplish the requested work
91+
3. Read resources/prompts for domain context when needed
9192

9293
### Delegate to Specialists
9394

9495
For work requiring specialized expertise:
9596

9697
1. Search for agents with `agent_search`
97-
2. Spawn a subtask with `subtask_run` and specific agent
98+
2. Spawn a subtask with `subtask` and specific agent
9899
3. Continue main task while subtask runs in parallel
99100

100101
### Context-Driven Execution
101102

102103
For tasks requiring domain knowledge:
103104

104-
1. Read relevant resources with `resource_read`
105-
2. Read workflow templates with `prompt_read`
105+
1. Read relevant resources with `read_resource`
106+
2. Read workflow templates with `read_prompt`
106107
3. Use context to inform tool selection and execution
107108

108109
---

apps/docs/client/src/content/deco-studio/en/studio/monitoring.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import Callout from "../../../../components/ui/Callout.astro";
1111
deco Studio treats monitoring as **infrastructure, not an afterthought**. Every tool invocation that flows through the control plane creates a monitoring log—there's no way to disable this, and that's by design.
1212

1313
<Callout type="tip">
14-
**Every tool call is monitored by deco Studio.** Whether it's a simple GitHub query or a complex database operation, every MCP tool invocation creates a structured log entry with full request/response details, timing, attribution, and error information. This happens automatically—no configuration required.
14+
**MCP proxy tool calls are monitored by deco Studio.** Tool invocations that flow through connections and Virtual MCPs (e.g., GitHub queries, database operations, Shopify calls) create structured log entries with full request/response details, timing, attribution, and error information. This happens automatically—no configuration required. Internal management API operations (creating connections, managing API keys) are not included in monitoring logs.
1515
</Callout>
1616

1717
Traditional MCP deployments have fragmented observability: each client logs independently (or doesn't log at all), each MCP server has its own logging strategy, and there's no unified view of what happened across the system. deco Studio solves this by logging **at the control plane level**, creating a single source of truth for all MCP traffic.

apps/docs/client/src/content/deco-studio/pt-br/studio/api-keys.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,14 @@ API keys permitem que sistemas externos se conectem ao deco Studio sem precisar
2828

2929
## Criando uma API Key
3030

31-
1. Abra o **Painel do deco Studio**
32-
2. Vá em **Settings****API Keys**
33-
3. Clique em **Create API Key**
34-
4. Dê um nome (como "Meu Script de Automação")
35-
5. Atribua [papéis e permissões](/pt-br/studio/user-management)
36-
6. **Copie a chave imediatamente**
31+
API keys são gerenciadas através das ferramentas MCP de gerenciamento ou da API. Ao criar uma API key, você especifica:
32+
33+
1. Um nome descritivo (como "Meu Script de Automação")
34+
2. Permissões diretas no formato `{ resource: [actions...] }` — onde o recurso é `"self"` para ferramentas de gerenciamento ou `"conn_<UUID>"` para acesso específico a conexões
35+
3. **Copie a chave imediatamente** — ela só é exibida uma vez
3736

3837
<Callout type="error">
39-
Você só pode ver a API key uma vez. Copie agora e armazene em um lugar seguro como um gerenciador de senhas.
38+
Você só pode ver a API key uma vez. Armazene em um lugar seguro como um gerenciador de senhas.
4039
</Callout>
4140

4241
## Usando Sua API Key

apps/docs/client/src/content/deco-studio/pt-br/studio/concepts.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,18 @@ icon: BookOpen
99
- **Organização**: o limite de tenant de nível superior. Tudo (conexões, agentes, projetos, logs) é escopado por organização.
1010
- **Membros**: usuários convidados para uma organização com papéis e permissões específicos.
1111
- **Conexão**: um endpoint MCP upstream configurado (geralmente HTTP), opcionalmente com credenciais armazenadas. Veja [Conexões](/pt-br/studio/connections).
12-
- **MCP Virtual**: agrega ferramentas/recursos/prompts de servidores conectados em um único MCP. Veja [MCPs Virtuais](/pt-br/studio/virtual-mcps).
13-
- **Agente**: MCPs Virtuais de propósito único otimizados para tarefas específicas. Veja [Agentes](/pt-br/studio/agents).
12+
- **MCP Virtual**: agrega ferramentas/recursos/prompts de servidores conectados em um único MCP. Agentes e Projetos são ambos MCPs Virtuais diferenciados por um campo `subtype`. Veja [MCPs Virtuais](/pt-br/studio/virtual-mcps).
13+
- **Agente**: um MCP Virtual com subtype `agent` — focado em tarefas específicas com conjunto curado de ferramentas. Veja [Agentes](/pt-br/studio/agents).
14+
- **Projeto**: um MCP Virtual com subtype `project` — organiza ferramentas, recursos, prompts e configurações específicas de projeto. Veja [Projetos](/pt-br/studio/projects).
1415
- **Automação**: execuções autônomas de agentes em agendamento ou gatilho de evento. Veja [Automações](/pt-br/studio/automations).
15-
- **Projeto**: MCPs Virtuais para organizar ferramentas, recursos, prompts e configurações específicas de projeto. Veja [Projetos](/pt-br/studio/projects).
16+
- **Thread**: uma sessão de conversa persistente com um agente. Armazena mensagens de chat e rastreia status (`in_progress`, `requires_action`, `completed`, `failed`).
17+
- **Event Bus**: sistema pub/sub entre conexões seguindo a spec CloudEvents v1.0. Suporta entrega agendada, eventos recorrentes via cron e garantias de entrega at-least-once.
18+
- **Tags**: labels no nível da organização para categorizar e filtrar membros.
19+
- **Chaves de Provedor de IA**: gerenciamento de API keys para provedores de modelos de IA (ex: OpenRouter).
1620

1721
## Entendendo Agentes vs. Projetos
1822

19-
Tanto agentes quanto projetos são MCPs Virtuais, mas servem propósitos diferentes no seu fluxo de trabalho:
23+
Tanto agentes quanto projetos são MCPs Virtuais armazenados na mesma tabela `connections`, diferenciados por um campo `subtype` (`agent` ou `project`). Eles servem propósitos diferentes no seu fluxo de trabalho:
2024

2125
**Projetos** são unidades organizacionais de uso geral para trabalho contínuo:
2226
- **Escopo amplo** - Cobrem múltiplos fluxos de trabalho e capacidades dentro de um contexto de trabalho
@@ -32,7 +36,7 @@ Tanto agentes quanto projetos são MCPs Virtuais, mas servem propósitos diferen
3236
- **Exemplo** - "Agente de Processamento de Reembolsos" que apenas processa reembolsos e autorizações de devolução de clientes
3337
- **Quando usar** - Operações focadas, gerenciamento integrado do mesh ou fluxos de trabalho especializados
3438

35-
Ambos seguem a mesma arquitetura de MCP Virtual, mas seus princípios de design diferem: projetos organizam capacidades para contextos de trabalho amplos, enquanto agentes são configurações reutilizáveis que podem ser instanciadas sob demanda com estado de execução limpo.
39+
Ambos compartilham a mesma arquitetura e modelo de armazenamento de MCP Virtual, mas seus princípios de design diferem: projetos organizam capacidades para contextos de trabalho amplos, enquanto agentes são configurações reutilizáveis que podem ser instanciadas sob demanda com estado de execução limpo.
3640

3741
## Primitivas do Protocolo MCP
3842

apps/docs/client/src/content/deco-studio/pt-br/studio/decopilot/context.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Veja [Agentes](/pt-br/studio/agents) para mais sobre como agentes fornecem conte
116116

117117
## Como os Escopos Afetam o Contexto
118118

119-
Cada [escopo](/pt-br/studio/decopilot/scopes) tem acesso apenas as suas proprias ferramentas e recursos. Quando voce troca de escopo, as ferramentas disponiveis atraves do `tool_search` mudam para corresponder ao MCP virtual daquele escopo, e as instrucoes que carregam no slot de instrucoes de escopo mudam — organizacao, projeto ou agente especifico. Veja [Escopos](/pt-br/studio/decopilot/scopes) para detalhes.
119+
Cada [escopo](/pt-br/studio/decopilot/scopes) tem acesso apenas as suas proprias ferramentas e recursos. Quando voce troca de escopo, as ferramentas disponiveis do escopo mudam para corresponder ao MCP virtual daquele escopo, e as instrucoes que carregam no slot de instrucoes de escopo mudam — organizacao, projeto ou agente especifico. Veja [Escopos](/pt-br/studio/decopilot/scopes) para detalhes.
120120

121121
## Dicas Praticas
122122

0 commit comments

Comments
 (0)