> ## 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.

# MCP tools · Users

> Tools to see who uses the script, ban, disable, reactivate, see history and pause the script. Owner only.

Tools to see who uses the script, ban, disable, reactivate, see history and pause the script. Owner only.

| Tool | What it does | Type |
| - | - | - |
| `list_users` | Who opened the script (@username), status, version, site and uses. Owner only. | Read |
| `set_user_status` | banned, disabled (with optional until) or active. Applies on the next open. Owner only. | Destructive |
| `user_history` | Opens and actions (of one user or everyone). | Read |
| `pause_script` | Pauses or resumes the script for everyone (the owner can still open it). Owner only. | Destructive |

## list\_users

**Who used it.** Who opened the script (@username), status, version, site and uses. Owner only.

> [!NOTE]
>
> Read only: changes nothing. Confirmation belongs to the AI client; scopes and blocks still apply.

### Parameters

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

Script ID (uuid)

### What it calls in the API

Por baixo, a ferramenta usa `GET /scripts/{script_id}/studio/users` da [API do Scripts](https://docs.doglytdc.dev/en/scripts/api.md). The response includes text and structuredContent, with secrets removed.

### Example

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

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

## set\_user\_status

**Ban/disable/reactivate.** banned, disabled (with optional until) or active. Applies on the next open. Owner only.

> [!NOTE]
>
> Writes or changes script data. Destructive action: review in your AI client before confirming. Confirmation belongs to the AI client; scopes and blocks still apply.

### Parameters

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

Script ID (uuid)

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

Row ID in list\_users

**status** `string` *required*

New status Values: `active`, `disabled`, `banned`.

**reason** `string`

Reason

**until** `string`

End of the suspension (ISO)

### What it calls in the API

Por baixo, a ferramenta usa `PATCH /scripts/{script_id}/studio/users/{user_id}` da [API do Scripts](https://docs.doglytdc.dev/en/scripts/api.md). The response includes text and structuredContent, with secrets removed.

### Example

```json Request 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 Response theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{ ...response JSON... }"
      }
    ],
    "isError": false
  }
}
```

## user\_history

**History.** Opens and actions (of one user or everyone).

> [!NOTE]
>
> Read only: changes nothing. Confirmation belongs to the AI client; scopes and blocks still apply.

### Parameters

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

Script ID (uuid)

**user\_id** `string`

Row ID (optional)

### What it calls in the API

Por baixo, a ferramenta usa `GET /scripts/{script_id}/studio/user-events[/{user_id}]` da [API do Scripts](https://docs.doglytdc.dev/en/scripts/api.md). The response includes text and structuredContent, with secrets removed.

### Example

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

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

## pause\_script

**Pause for everyone.** Pauses or resumes the script for everyone (the owner can still open it). Owner only.

> [!NOTE]
>
> Writes or changes script data. Destructive action: review in your AI client before confirming. Confirmation belongs to the AI client; scopes and blocks still apply.

### Parameters

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

Script ID (uuid)

**paused** `boolean` *required*

—

### What it calls in the API

Por baixo, a ferramenta usa `POST /scripts/{script_id}/studio/pause` da [API do Scripts](https://docs.doglytdc.dev/en/scripts/api.md). The response includes text and structuredContent, with secrets removed.

### Example

```json Request 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 Response theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{ ...response JSON... }"
      }
    ],
    "isError": false
  }
}
```


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