> ## Documentation Index
> Fetch the complete documentation index at: https://docs.doglytdc.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Ferramentas do MCP · Usuários

> Ferramentas para ver quem usa o script, banir, desativar, reativar, ver histórico e pausar o script. Só o dono.

Ferramentas para ver quem usa o script, banir, desativar, reativar, ver histórico e pausar o script. Só o dono.

| Ferramenta | O que faz | Tipo |
| - | - | - |
| `list_users` | Quem abriu o script (@username), status, versão, site e usos. Só o dono. | Leitura |
| `set_user_status` | banned, disabled (com until opcional) ou active. Vale na próxima abertura. Só o dono. | Destrutiva |
| `user_history` | Aberturas e ações (de um usuário ou de todos). | Leitura |
| `pause_script` | Pausa ou retoma o script para todos (o dono continua abrindo). Só o dono. | Destrutiva |

## list\_users

**Quem usou.** Quem abriu o script (@username), status, versão, site e usos. Só o dono.

> [!NOTE]
>
> Só leitura: não muda nada. Confirmação no cliente de IA; escopos e bloqueios continuam valendo.

### Parâmetros

**script\_id** `string` *required*

ID do script (uuid)

### O que chama na API

Por baixo, a ferramenta usa `GET /scripts/{script_id}/studio/users` da [API do Scripts](https://docs.doglytdc.dev/pt-BR/scripts/api.md). A resposta inclui texto e structuredContent, com segredos removidos.

### Exemplo

```json Pedido theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_users",
    "arguments": {
      "script_id": "8f0c2c1e-5b0a-4d2e-9a61-3f7d2b1c9e40"
    }
  }
}
```

```json Resposta theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{ ...JSON da resposta... }"
      }
    ],
    "isError": false
  }
}
```

## set\_user\_status

**Banir/desativar/reativar.** banned, disabled (com until opcional) ou active. Vale na próxima abertura. Só o dono.

> [!NOTE]
>
> Grava ou muda dados do script. Ação destrutiva: confira antes de aprovar. Confirmação no cliente de IA; escopos e bloqueios continuam valendo.

### Parâmetros

**script\_id** `string` *required*

ID do script (uuid)

**user\_id** `string` *required*

ID da linha em list\_users

**status** `string` *required*

Novo status Valores: `active`, `disabled`, `banned`.

**reason** `string`

Motivo

**until** `string`

Fim da desativação (ISO)

### O que chama na API

Por baixo, a ferramenta usa `PATCH /scripts/{script_id}/studio/users/{user_id}` da [API do Scripts](https://docs.doglytdc.dev/pt-BR/scripts/api.md). A resposta inclui texto e structuredContent, com segredos removidos.

### Exemplo

```json Pedido theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "set_user_status",
    "arguments": {
      "script_id": "8f0c2c1e-5b0a-4d2e-9a61-3f7d2b1c9e40",
      "user_id": "d4e6f8a0-2b4c-4e6f-8a0b-1c2d3e4f5a6b",
      "status": "disabled"
    }
  }
}
```

```json Resposta theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{ ...JSON da resposta... }"
      }
    ],
    "isError": false
  }
}
```

## user\_history

**Histórico.** Aberturas e ações (de um usuário ou de todos).

> [!NOTE]
>
> Só leitura: não muda nada. Confirmação no cliente de IA; escopos e bloqueios continuam valendo.

### Parâmetros

**script\_id** `string` *required*

ID do script (uuid)

**user\_id** `string`

ID da linha (opcional)

### O que chama na API

Por baixo, a ferramenta usa `GET /scripts/{script_id}/studio/user-events[/{user_id}]` da [API do Scripts](https://docs.doglytdc.dev/pt-BR/scripts/api.md). A resposta inclui texto e structuredContent, com segredos removidos.

### Exemplo

```json Pedido theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "user_history",
    "arguments": {
      "script_id": "8f0c2c1e-5b0a-4d2e-9a61-3f7d2b1c9e40"
    }
  }
}
```

```json Resposta theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{ ...JSON da resposta... }"
      }
    ],
    "isError": false
  }
}
```

## pause\_script

**Pausar para todos.** Pausa ou retoma o script para todos (o dono continua abrindo). Só o dono.

> [!NOTE]
>
> Grava ou muda dados do script. Ação destrutiva: confira antes de aprovar. Confirmação no cliente de IA; escopos e bloqueios continuam valendo.

### Parâmetros

**script\_id** `string` *required*

ID do script (uuid)

**paused** `boolean` *required*

—

### O que chama na API

Por baixo, a ferramenta usa `POST /scripts/{script_id}/studio/pause` da [API do Scripts](https://docs.doglytdc.dev/pt-BR/scripts/api.md). A resposta inclui texto e structuredContent, com segredos removidos.

### Exemplo

```json Pedido theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "pause_script",
    "arguments": {
      "script_id": "8f0c2c1e-5b0a-4d2e-9a61-3f7d2b1c9e40",
      "paused": true
    }
  }
}
```

```json Resposta theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{ ...JSON da resposta... }"
      }
    ],
    "isError": false
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.