Harumi

Referência de ferramentas

Todas as ferramentas e ações que o servidor MCP da Harumi expõe ao ChatGPT e ao Claude, com os parâmetros de cada uma.

Como as ferramentas são organizadas

Cada ferramenta cobre uma área da Harumi e recebe um argumento action que escolhe o que ela faz — do mesmo jeito que a CLI agrupa comandos. Leitura e alteração ficam em ferramentas separadas (runs e runs_manage, por exemplo), para que seu app de chat saiba diferenciá-las:

  • Ferramentas de leitura não mudam nada.
  • Ferramentas de escrita mudam algo que você pode refazer.
  • Ferramentas destrutivas podem remover ou sobrescrever algo que a Harumi não consegue recuperar. Seu app de chat pede sua confirmação antes de executar uma delas.

Você não chama essas ferramentas pelo nome — pergunte em linguagem natural e o modelo escolhe a ferramenta. Esta página serve para saber o que é possível.

A maioria das ferramentas de projeto recebe um project_id. Raramente você precisa informá-lo: peça um projeto pelo nome e o modelo busca o id com projects.

Conta

profile — leitura

AçãoO que faz
showSeu id, email e nome na Harumi.

profile_manage — escrita

AçãoO que faz
setAltera seu próprio perfil. Passe só os campos a mudar: first_name, last_name, bio, avatar.

org — leitura

AçãoO que faz
listTodas as organizações de que você faz parte, com seu papel em cada uma.
membersOs membros de uma organização (organization_id): nome, email, papel e se o convite ainda está pendente.

Criar ou excluir organizações, convidar ou remover pessoas e mudar papéis não estão disponíveis.

Projetos e execuções

projects — leitura

AçãoO que faz
listTodos os projetos das suas organizações e depois seus projetos pessoais, cada um com sua organização e o status da última execução. Passe organization_id para restringir a uma organização.
getOs detalhes de um projeto, buscado pelo name, ou pelo project_id quando vários projetos têm o mesmo nome.

runs — leitura

AçãoO que faz
listAs execuções de um projeto, da mais recente para a mais antiga: comando, horário, branch, se uma pessoa ou um agendamento a iniciou, e status.
getUma execução (run_id) completa: status, kernel spec, branch, commit, horário de início e duração.
logsO log de uma execução — as últimas 200 linhas por padrão, com um link para o log completo. Passe tail_lines para ver mais.
outputsOs resultados de uma execução desenhados como o dashboard do projeto, do jeito que a Harumi mostra. Usa a última execução concluída quando run_id não é informado. Passe dashboard (um caminho de spec como dashboard/costs.toml) para escolher um quando o projeto tem vários.

runs_manage — destrutiva

AçãoO que faz
startEnfileira uma nova execução e retorna na hora — não espera a execução terminar. Opcionais: branch (a branch live quando não informada), commit, command, kernel_spec. Acompanhe o progresso depois com runs → get.
cancelCancela uma execução em andamento (run_id). A Harumi não consegue retomar uma execução cancelada. Falha com uma mensagem clara quando a execução já terminou.

Código

repo — leitura

Navega pelo repositório git de um projeto. Todas as ações exceto branches recebem um ref opcional (uma branch, tag ou commit) e usam a branch live quando ele não é informado.

AçãoO que faz
lsTodos os arquivos do repositório.
dirUma pasta (path, a raiz quando não informado), com o último commit de cada item.
branchesAs branches, com a live — a que os agendamentos executam — marcada.
commitsUma página do histórico de commits. Passe path para um arquivo ou pasta, e page / per_page para navegar pelas páginas.
readinessSe o projeto pode ser executado, nomeando cada verificação que o bloqueia.
catO conteúdo de um arquivo (path). Conteúdo acima de 20.000 caracteres é cortado, com um link para o arquivo na Harumi.
downloadO repositório, ou uma pasta (path), como arquivo zip. Um arquivo grande volta como link.

repo_manage — destrutiva

Altera somente branches temporárias. Nunca escreve na branch live nem a remove, e nunca promove uma branch para live.

AçãoO que faz
branch-createCria uma branch (name) a partir de from_branch (a branch live quando não informada).
branch-rmRemove uma branch (name). A Harumi não consegue recuperá-la.
putCria ou atualiza um arquivo (path) em branch com content. Conteúdo acima de 20.000 caracteres é recusado, com um link para concluir a escrita na Harumi.
rmRemove um arquivo, ou os arquivos de uma pasta (path), de branch.
mvMove ou renomeia um arquivo ou pasta de from_path para to_path em branch.

Arquivos

Os arquivos de um projeto são o armazenamento de arquivos fora do git — separado do repositório.

files — leitura

AçãoO que faz
lsTodos os arquivos, com o tamanho de cada um.
getO conteúdo de um arquivo (path). Conteúdo acima de 20.000 caracteres é cortado, com um link para o arquivo na Harumi.

files_manage — destrutiva

AçãoO que faz
putEnvia content para path, criando ou sobrescrevendo o arquivo. Conteúdo acima de 20.000 caracteres é recusado, com um link para concluir o envio na Harumi.
rmRemove um arquivo (path). A Harumi não consegue recuperá-lo.

Dados e automação

datasources — leitura

AçãoO que faz
listAs fontes de dados de um projeto: nome, tipo e destino da conexão — nunca uma senha ou segredo de conexão. Passe limit / offset para paginar.
getOs detalhes de uma fonte de dados (name).
queryExecuta uma query de leitura em uma fonte de dados (name) e mostra o resultado como tabela. Traz no máximo 100 linhas; um resultado maior é cortado, com um aviso.

Criar, alterar ou excluir fontes de dados não está disponível.

schedules — leitura

AçãoO que faz
listOs agendamentos de um projeto, com cron, branch, kernel spec e status.
getUm agendamento (schedule_id) completo.

schedules_manage — destrutiva

AçãoO que faz
addCria um agendamento que roda em cron. Opcionais: start_at (ISO 8601, agora quando não informado), git_branch (a branch live quando não informada), git_commit, command, kernel_spec, output_format, email_to.
updateAltera um agendamento (schedule_id). Passe só os campos a mudar; os demais mantêm o valor atual.
rmRemove um agendamento (schedule_id). A Harumi não consegue recuperá-lo.

catalogue — leitura

AçãoO que faz
specsAs kernel specs que um projeto pode usar: nome, nome de exibição, linguagem e se exige assinatura.
templatesOs templates a partir dos quais um novo projeto pode começar: slug, nome e descrição.

Segredos e compartilhamento

secrets — leitura

AçãoO que faz
listOs nomes dos segredos de um projeto. Nunca o valor de um segredo.

secrets_manage — destrutiva

AçãoO que faz
setDefine o segredo name como value, sobrescrevendo um segredo com o mesmo nome.
rmRemove um segredo (name). A Harumi não consegue recuperá-lo.

share — leitura

Links de compartilhamento são links públicos para o dashboard de um projeto.

AçãoO que faz
listOs links de compartilhamento de um projeto: id, rótulo, se está ativo e se tem senha.
getUm link (link_id) completo, incluindo o token de compartilhamento. Nunca a senha.

share_manage — destrutiva

AçãoO que faz
addCria um link com um label opcional. Cada permissão — app_enabled, chat_enabled, run_history_enabled, comparisons_enabled (exige o histórico), run_control_enabled, io_control_enabled — fica desligada a menos que seja definida como true.
updateAltera um link (link_id). Passe só os campos a mudar; enabled liga ou desliga o link.
rmRemove um link. A URL dele para de funcionar, e a Harumi não consegue recuperá-lo.
rotateDá ao link um novo token de compartilhamento. A URL antiga para de funcionar.
set-passwordDefine uma password que quem abre o link precisa informar.
rm-passwordRemove a senha do link.

Não disponível

Estas ações ficam fora do servidor MCP de propósito, porque a Harumi não tem como desfazê-las. Use a plataforma:

  • Excluir um projeto, uma organização ou uma fonte de dados.
  • Convidar ou remover pessoas, ou mudar o papel de alguém.
  • Promover uma branch para live, ou escrever na branch live.
  • Qualquer coisa relacionada a cobrança.

On this page