> ## 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 · Código

> Ferramentas para ler a árvore de arquivos, ler um arquivo, gravar commits e procurar texto no código.

Ferramentas para ler a árvore de arquivos, ler um arquivo, gravar commits e procurar texto no código.

| Ferramenta | O que faz | Tipo |
| - | - | - |
| `get_presentation` | Lê a apresentação validada, commit aplicado e erros, sem publicar o executável. | Leitura |
| `validate_presentation` | Valida ui/site/ de uma branch ou commit. Não aplica branches de trabalho. | Leitura |
| `ensure_presentation_files` | Adiciona apenas arquivos ui/site/ ausentes ao repositório antigo. Não sobrescreve o executável. Exige expected\_head. | Grava |
| `read_tree` | Lista os arquivos de uma branch ou commit. | Leitura |
| `read_file` | Conteúdo de um arquivo. | Leitura |
| `write_files` | Grava um commit. Leia o head da branch em list\_branches e envie em expected\_head. content null apaga o arquivo. | Grava |
| `search_code` | Procura um texto em todos os arquivos de um ref (até 50 resultados). | Leitura |

## get\_presentation

**Ver apresentação aplicada.** Lê a apresentação validada, commit aplicado e erros, sem publicar o executável.

> [!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)

### Exemplo

```json Pedido theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_presentation",
    "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
  }
}
```

## validate\_presentation

**Validar cartão e popup.** Valida ui/site/ de uma branch ou commit. Não aplica branches de trabalho.

> [!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)

**ref** `string`

Branch ou commit

### Exemplo

```json Pedido theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "validate_presentation",
    "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
  }
}
```

## ensure\_presentation\_files

**Preparar apresentação.** Adiciona apenas arquivos ui/site/ ausentes ao repositório antigo. Não sobrescreve o executável. Exige expected\_head.

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

### Parâmetros

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

ID do script (uuid)

**expected\_head** `string | null` *required*

—

### Exemplo

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

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

## read\_tree

**Ler árvore.** Lista os arquivos de uma branch ou commit.

> [!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)

**ref** `string`

Branch ou SHA (padrão: principal)

### O que chama na API

Por baixo, a ferramenta usa `GET /scripts/{script_id}/repo/tree` 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": "read_tree",
    "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
  }
}
```

## read\_file

**Ler arquivo.** Conteúdo de um arquivo.

> [!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)

**path** `string` *required*

Caminho, ex.: src/script.js

**ref** `string`

Branch ou SHA

### O que chama na API

Por baixo, a ferramenta usa `GET /scripts/{script_id}/repo/files/{path}` 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": "read_file",
    "arguments": {
      "script_id": "8f0c2c1e-5b0a-4d2e-9a61-3f7d2b1c9e40",
      "path": "src/script.js"
    }
  }
}
```

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

## write\_files

**Gravar arquivos.** Grava um commit. Leia o head da branch em list\_branches e envie em expected\_head. content null apaga o arquivo.

> [!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)

**branch** `string`

Branch (padrão: principal)

**expected\_head** `string` *required*

head\_sha atual da branch

**message** `string` *required*

Mensagem do commit

**changes** `object[]` *required*

Lista de itens.

**campos de cada item**

**path** `string` *required*

Campo do item.

**content** `string | null` *required*

Campo do item.

### O que chama na API

Por baixo, a ferramenta usa `POST /scripts/{script_id}/repo/commits` 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": "write_files",
    "arguments": {
      "script_id": "8f0c2c1e-5b0a-4d2e-9a61-3f7d2b1c9e40",
      "expected_head": "3b1f0e9c2a7d4b6e8f0a1c3d5e7f9a1b2c3d4e5f",
      "message": "Atualiza o botão",
      "changes": [
        {
          "path": "src/script.js",
          "content": "// novo conteúdo"
        }
      ]
    }
  }
}
```

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

## search\_code

**Buscar no código.** Procura um texto em todos os arquivos de um ref (até 50 resultados).

> [!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)

**query** `string` *required*

Texto

**ref** `string`

Branch ou SHA

### O que chama na API

Por baixo, a ferramenta usa `GET /scripts/{script_id}/repo/tree`, `GET /scripts/{script_id}/repo/files/{path}` 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": "search_code",
    "arguments": {
      "script_id": "8f0c2c1e-5b0a-4d2e-9a61-3f7d2b1c9e40",
      "query": "createCard"
    }
  }
}
```

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