# TunnelHub

TunnelHub é uma plataforma de integração, automação e gerenciamento de APIs orientada a times que precisam operar fluxos em produção, com observabilidade, segurança e separação por ambiente.

Hoje a plataforma combina quatro frentes principais:

* Produto web para configurar ambientes, pacotes, Tabelas De/Para, sistemas, automações, APIs, usuários e configurações administrativas.
* SDK em TypeScript para implementar automações com fluxos prontos, logging, delta, parâmetros, Tabelas De/Para e Sequências.
* CLI para autenticar, listar recursos, criar pacotes, criar automações e publicar novas versões.
* MCP para investigação operacional, leitura de recursos e análise de execuções diretamente de clientes compatíveis com Model Context Protocol.

## O que você encontra no TunnelHub

* **Produto**: ambientes, pacotes, Tabelas De/Para, sistemas, automações, tabelas de conversão, Sequências, monitoramento e administração.
* **API Management**: definição de APIs, planos de uso, chaves de API, servidores de recursos, clientes e logs de execução.
* **Developer tooling**: CLI, SDK, MCP e skill para agentes com papéis diferentes no ciclo de desenvolvimento e suporte.

## Como navegar nesta documentação

* Se você está começando agora, siga [Criando sua primeira automação](https://docs.tunnelhub.io/primeiros-passos/creating-your-first-automation).
* Se você quer entender o modelo do produto, comece por [Conceitos principais](https://docs.tunnelhub.io/produto/core-concepts).
* Se você precisa modelar configuração operacional no produto, leia [Tabelas De/Para](https://docs.tunnelhub.io/produto/data-stores) e [Sistemas](https://docs.tunnelhub.io/produto/systems).
* Se você vai desenvolver integrações, consulte as seções de [CLI](https://docs.tunnelhub.io/cli/cli) e [SDK](https://docs.tunnelhub.io/sdk/sdk).
* Se você vai investigar execuções ou operar o ambiente via cliente MCP, consulte [MCP](https://docs.tunnelhub.io/mcp/mcp).

## Skill para agentes

Se você desenvolve automações com frequência, vale instalar o skill público `tunnelhub-sdk`. Ele ajuda a trabalhar com os fluxos do SDK, parâmetros, sistemas, Tabelas De/Para, Sequências, logging, interceptor HTTP e testes em plataformas de agentes compatíveis.

Instalação:

```bash
npx skills add tunnelhub/agent-skills --skill tunnelhub-sdk -a opencode
```

Instalação global:

```bash
npx skills add tunnelhub/agent-skills --skill tunnelhub-sdk -a opencode -g
```

## Requisitos gerais

* Node.js 22+ para os projetos atuais do monorepo.
* Acesso a uma conta TunnelHub com pelo menos um ambiente.
* Permissões adequadas para criar pacotes, automações, APIs ou usuários, dependendo do seu perfil.

## Principais conceitos

* **Ambiente**: separa configuração e execução, como DEV, QAS e PRD.
* **Pacote**: agrupador lógico de automações, sistemas e artefatos relacionados.
* **Sistema**: definição reutilizável de conexão com serviços externos.
* **Automação**: execução serverless ou em container que processa integrações e gera logs operacionais.
* **Tabela De/Para**: conjunto de dados configurável no produto, usado para mapeamentos, listas de referência e traduções de valores.
* **Tabela de conversão**: caso comum de uma Tabela De/Para usada para de/para entre sistemas.
* **Sequência**: gerador sequencial para identificadores controlados pela plataforma.

Use esta documentação como referência pública do estado atual da plataforma. Quando houver diferença entre exemplos antigos e o comportamento atual do produto, o produto e o código do repositório são a fonte de verdade.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.tunnelhub.io/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.