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

# MCP server

> Como usar o servidor MCP da Acrity com a API pública.

O servidor MCP da Acrity expõe ferramentas para clientes compatíveis com Model Context Protocol usando uma API key pública existente. Ele não cria credenciais de provedores e não precisa receber tokens de VCS ou PM. Duas ferramentas têm capacidade de escrita: `start_security_scan` enfileira um scan de segurança de dependências e `request_review` solicita um review. Ambas exigem que a API key tenha o escopo de escrita correspondente. Todas as outras ferramentas são somente leitura.

## Quando usar

Use o MCP server para permitir que um assistente consulte informações da Acrity, como repositórios, PRs, reviews, achados e security scans, dentro dos escopos autorizados pela API key.

Escopos recomendados para uso somente leitura:

```text theme={null}
Repositories.Read
Reviews.Read
SecurityScans.Read
```

Adicione:

* `SecurityScans.Write` quando o assistente puder iniciar scans sob demanda.
* `Reviews.Write` quando o assistente puder solicitar reviews.

## Configuração

Exemplo de configuração para cliente MCP quando o pacote npm estiver disponível:

```json theme={null}
{
  "mcpServers": {
    "acrity": {
      "command": "npx",
      "args": ["-y", "@acrity/mcp-server"],
      "env": {
        "ACRITY_API_BASE_URL": "https://acrity.io",
        "ACRITY_API_KEY": "acr_live_..."
      }
    }
  }
}
```

Use a URL base da Acrity, sem acrescentar `/api`. O servidor MCP monta os caminhos públicos automaticamente.

Para alterar quanto tempo o servidor aguarda cada chamada à API pública, defina a variável de ambiente opcional `ACRITY_MCP_TIMEOUT_MS` com o tempo limite em milissegundos. Se você omiti-la, o servidor usa um padrão de `20000` ms (20 segundos).

<Note>
  Se a Acrity fornecer uma distribuição diferente do MCP server para a sua instalação, mantenha o mesmo conjunto de variáveis e substitua apenas `command` e `args` pelo método de instalação informado pela Acrity.
</Note>

<Warning>
  Guarde a API key no cofre de segredos do cliente MCP. Não coloque a chave em repositórios, mensagens compartilhadas ou screenshots.
</Warning>

## Ferramentas disponíveis

| Ferramenta                    | Escopo                |
| ----------------------------- | --------------------- |
| `get_acr_context`             | API key válida        |
| `list_repositories`           | `Repositories.Read`   |
| `get_repository`              | `Repositories.Read`   |
| `list_pull_requests`          | `Reviews.Read`        |
| `get_pull_request`            | `Reviews.Read`        |
| `list_reviews`                | `Reviews.Read`        |
| `get_review_findings`         | `Reviews.Read`        |
| `request_review`              | `Reviews.Write`       |
| `check_bootstrap_eligibility` | `Repositories.Read`   |
| `get_bootstrap_status`        | `Repositories.Read`   |
| `get_bootstrap_artifact`      | `Repositories.Read`   |
| `list_security_scans`         | `SecurityScans.Read`  |
| `get_security_scan`           | `SecurityScans.Read`  |
| `start_security_scan`         | `SecurityScans.Write` |

As ferramentas `list_` seguem o limite de paginação da API pública e retornam no máximo 50 itens por página. Solicite a próxima página para obter mais resultados.

## Validação

Depois de configurar, chame `get_acr_context`. A ferramenta confirma workspace, escopos e disponibilidade da API a partir da visão daquela key.

Se uma ferramenta retornar falta de permissão, crie ou edite a API key no Console com o escopo mínimo necessário.