moedux-cli
Instruções para um agente de IA usar o moedux-cli, o cliente oficial da API /api/v1 da Moedux: instalar, autenticar com API Key, ler diagnóstico financeiro (Gasto Diário, Mar Vermelho), transações e patrimônio, e criar, editar ou excluir transações e aplicar cenários. Use when o usuário pedir para consultar a conta Moedux, analisar as finanças, listar ou alterar transações, comparar cenários, ou quando o comando `moedux` estiver disponível no ambiente.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/jhonnysabino--moedux-agent-tools)HTML
<a href="/listings/jhonnysabino--moedux-agent-tools"><img src="/api/listings/jhonnysabino--moedux-agent-tools/badge.svg" alt="findsafeskills safety rating" /></a>Install
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
SKILL.md · Manifest · 101 lines · 1 finding marked
- ---
- name: moedux-cli
- description: >-
- Instruções para um agente de IA usar o moedux-cli, o cliente oficial da API
- /api/v1 da Moedux: instalar, autenticar com API Key, ler diagnóstico
- financeiro (Gasto Diário, Mar Vermelho), transações e patrimônio, e criar,
- editar ou excluir transações e aplicar cenários. Use when o usuário pedir
- para consultar a conta Moedux, analisar as finanças, listar ou alterar
- transações, comparar cenários, ou quando o comando `moedux` estiver
- disponível no ambiente.
- ---
- # moedux-cli
- CLI Go com entrada/saída JSON para a conta Moedux. O cliente não tem regra de
- negócio: o servidor decide, o CLI transpõe o contrato `/api/v1`.
- ## Contrato da API
- A especificação OpenAPI 3.1 legível por máquina está em
- `https://www.moedux.com/openapi.json`. Consulte-a para confirmar caminhos,
- corpos de requisição, formatos de resposta e a permissão exata (`x-permission`)
- de cada operação antes de chamar a API — não adivinhe o formato de um campo.
- A CLI cobre todas as operações publicadas; o contrato é a fonte canônica quando
- os dois diferirem.
- ## Instalar
- ```sh
- curl -fsSL https://www.moedux.com/static/cli-install.sh | sh
- Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
- Line 30 on GitHub
- ```
- Instala em `~/.local/bin` (sobrescreva com `MOEDUX_CLI_INSTALL_DIR`).
- ## Autenticação (obrigatória)
- 1. Crie a API Key na UI: Configurações > API Keys. Escolha permissões mínimas.
- 2. Exporte uma vez por sessão: `export MOEDUX_API_KEY=moedux_live_<segredo>` (ou `--api-key`, que tem prioridade).
- 3. A base URL é fixa em `https://www.moedux.com`. Não passe `--base-url`; use apenas para apontar staging/local.
- A chave nunca é impressa pelo CLI. Permissões válidas: `diagnosis:read`,
- `transactions:read`, `transactions:write`, `scenarios:compare`,
- `scenarios:apply`, `networth:read`.
- ## Comandos de leitura (nunca alteram dados)
- ```sh
- moedux diagnosis [--horizon-days N] # balance, dailyVariableSpend.value/confidence/windowDays, redSeaDate, projection[], userTier
- moedux transactions list [--type income|expense|savings|credit_card] [--from D] [--to D] [--limit N]
- moedux networth # { items[], total }
- ```
- `confidence` usa o vocabulário canônico: `Sem dados | Aprendendo | Confiável`.
- ## Comandos de escrita (alteram dados)
- ```sh
- moedux transactions add <json | --fields>
- moedux transactions edit <id> --mode only|from|all [--fields]
- moedux transactions remove <id> [--mode only|from|all] [--date D]
- ```
- - Campos do JSON/`--fields`: `id` (UUID, opcional), `amount`, `type`, `frequency` (`once|daily|monthly`), `description`, `startDate` (YYYY-MM-DD), `dayOfMonth`, `isStartingBalance`.
- - `add --fields` gera o `id` como UUID, para idempotência.
- - Editar/excluir recorrência exige `--mode` (`only|from|all`): mesma semântica de escopo da UI. `only/from` exigem `--date`.
- - Sempre `list` antes de `edit`/`remove` para obter o `id` real.
- ## Cenários
- ```sh
- moedux scenarios compare <json> [--horizon-days N] # NÃO grava. Compare sempre primeiro.
- moedux scenarios apply <json> # GRAVA. Atômico: converte itens em transações reais.
- ```
- ## Códigos de saída (o agente deve reagir a eles)
- | Código | Significado | Ação do agente |
- |--------|-------------|----------------|
- | 0 | sucesso | use o JSON do stdout |
- | 1 | uso/argumento | corrija flags ou JSON e repita |
- | 2 | autenticação/permissão (401/403) | confira chave e permissões; nunca retente cegamente |
- | 3 | validação (422) | `stderr` lista os campos; corrija e repita |
- | 4 | servidor/rede | retente uma vez; se persistir, pare e reporte |
- JSON de dados sai no stdout; erros saem no stderr. Capture o stdout direto,
- sem misturar com logs.
- ## Receita típica (agente)
- ```sh
- export MOEDUX_API_KEY=moedux_live_xxx
- moedux diagnosis | jq -r '.redSeaDate // "sem mar vermelho"'
- moedux transactions list --type expense --from "$(date +%F)" | jq '.total'
- moedux scenarios compare "$(cat cenário.json)" | jq '.projection[0]'
- ```
- 1. Leia sempre `diagnosis` primeiro: o Mar Vermelho (`redSeaDate`) é o alerta
- mais urgente.
- 2. Antes de qualquer escrita, liste e compare.
- 3. Nunca aplique um cenário sem ter mostrado o `compare` ao usuário.
- 4. Não invente valores ou IDs: o que não vier da API, pergunte ao usuário.
README.md · README · 71 lines · 1 finding marked
- # Moedux — ferramentas para agentes de IA
- [Moedux](https://www.moedux.com/?utm_source=github&utm_medium=repo&utm_campaign=agent-tools) é um aplicativo brasileiro de finanças pessoais: transações, contas e estimativas de gasto viram um diagnóstico legível e uma próxima ação concreta.
- Este repositório reúne os artefatos que um agente de IA precisa para usar o Moedux sem adivinhar formato de campo nem permissão de API. É um espelho público e versionado do que o próprio app publica em `/developers`.
- ## Servidor MCP (registro oficial)
- O Moedux publica um servidor MCP remoto (Streamable HTTP) no **Registro Oficial de MCP**, sem cadastro nem chave de API:
- - Endpoint: `https://www.moedux.com/mcp`
- - Registro: `io.github.jhonnysabino/moedux@1.0.0` — https://registry.modelcontextprotocol.io/v0.1/servers/io.github.jhonnysabino%2Fmoedux/versions/1.0.0
- - Server Card SEP-1649: https://www.moedux.com/.well-known/mcp.json
- - Conector Glama (qualidade das ferramentas): https://glama.ai/mcp/connectors/io.github.jhonnysabino/moedux
- - Lista de servidores MCP remotos, categoria Finance: https://github.com/punkpeye/awesome-remote-mcp-servers/pull/5498
- Ferramentas disponíveis:
- - `prever_mar_vermelho` — data prevista em que o saldo chega a zero (Mar Vermelho), com link pré-preenchido.
- - `projetar_saldo_12_meses` — saldo projetado em 12 meses e a data do Mar Vermelho, com link pré-preenchido e citação da fonte.
- Exemplo de configuração para um cliente MCP:
- ```json
- {
- "mcpServers": {
- "moedux": {
- "type": "streamable-http",
- "url": "https://www.moedux.com/mcp"
- }
- }
- }
- ```
- ## Contrato da API
- - Especificação OpenAPI 3.1: [`openapi.json`](openapi.json) — espelho de https://www.moedux.com/openapi.json
- - Documentação para humanos: https://www.moedux.com/developers?utm_source=github&utm_medium=repo&utm_campaign=agent-tools
- - Autenticação: HTTP Bearer com API Key criada em Configurações > API Keys no app.
- Cada operação carrega `x-permission`. Peça sempre a permissão mínima: `diagnosis:read`, `transactions:read`, `transactions:write`, `scenarios:compare`, `scenarios:apply` ou `networth:read`.
- ## Skill do CLI
- [`SKILL.md`](SKILL.md) ensina um agente a instalar e usar o `moedux-cli`, o cliente oficial da API `/api/v1` com entrada e saída JSON. Instalação:
- ```sh
- curl -fsSL https://www.moedux.com/static/cli-install.sh | sh
- Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
- Line 48 on GitHub
- ```
- O binário aceita `diagnosis`, `transactions list|add|edit|remove`, `networth` e `scenarios compare|apply`. A especificação em `openapi.json` é a fonte canônica quando houver divergência.
- ## Começando sem cartão
- O cadastro cria 14 dias de teste gratuito: https://www.moedux.com/app/login?utm_source=github&utm_medium=repo&utm_campaign=agent-tools
- ## Guias de finanças pessoais
- Conteúdo gratuito e independente, mantido no gist canônico do projeto:
- - [Guia prático de controle financeiro com modelos CSV](https://gist.github.com/jhonnysabino/8e2a46d8947166f362cfaab7f3f7cee7#file-guia-controle-financeiro-md)
- - [Reserva de emergência: como montar e quanto guardar](https://gist.github.com/jhonnysabino/8e2a46d8947166f362cfaab7f3f7cee7#file-guia-reserva-emergencia-md)
- - [Comparativo de aplicativos de finanças pessoais](https://gist.github.com/jhonnysabino/8e2a46d8947166f362cfaab7f3f7cee7#file-guia-comparativo-apps-md)
- ## Atualização
- Os arquivos deste repositório são gerados a partir do código do app. Para atualizar, copie `cmd/moedux-cli/SKILL.md` e o `GET /openapi.json` da versão publicada.
- ---
- Moedux · [Termos de uso](https://www.moedux.com/terms-of-use?utm_source=github&utm_medium=repo&utm_campaign=agent-tools) · [Privacidade](https://www.moedux.com/privacy-policy?utm_source=github&utm_medium=repo&utm_campaign=agent-tools)
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.