pluggy-mcp 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +113 -0
- package/dist/index.js +29409 -0
- package/package.json +61 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
# pluggy-mcp
|
|
2
|
+
|
|
3
|
+
Servidor MCP para **[Pluggy](https://pluggy.ai)** — agregador Open Finance Brasil (ITP/TPP).
|
|
4
|
+
|
|
5
|
+
Baseado no [`@codespar/mcp-pluggy`](https://www.npmjs.com/package/@codespar/mcp-pluggy) por [CodeSpar](https://codespar.dev), estendido com funcionalidades adicionais.
|
|
6
|
+
|
|
7
|
+
> **Licença:** MIT — mantém os créditos ao trabalho original da CodeSpar.
|
|
8
|
+
|
|
9
|
+
## Setup
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
bun install
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Quick Start
|
|
16
|
+
|
|
17
|
+
### Via npx (recomendado)
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx pluggy-mcp
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### Claude Desktop
|
|
24
|
+
|
|
25
|
+
Adicione ao `claude_desktop_config.json`:
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"mcpServers": {
|
|
30
|
+
"pluggy": {
|
|
31
|
+
"command": "npx",
|
|
32
|
+
"args": ["pluggy-mcp"],
|
|
33
|
+
"env": {
|
|
34
|
+
"PLUGGY_CLIENT_ID": "seu-client-id",
|
|
35
|
+
"PLUGGY_CLIENT_SECRET": "seu-client-secret"
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Cursor / VS Code
|
|
43
|
+
|
|
44
|
+
Mesma configuração em `.cursor/mcp.json` ou no JSON de MCP do VS Code.
|
|
45
|
+
|
|
46
|
+
## Autenticação
|
|
47
|
+
|
|
48
|
+
Pluggy usa OAuth2 client-credentials. Obtenha suas credenciais no [dashboard da Pluggy](https://dashboard.pluggy.ai).
|
|
49
|
+
|
|
50
|
+
| Variável | Obrigatório | Descrição |
|
|
51
|
+
|---|---|---|
|
|
52
|
+
| `PLUGGY_CLIENT_ID` | sim | Client ID do dashboard |
|
|
53
|
+
| `PLUGGY_CLIENT_SECRET` | sim | Client Secret do dashboard |
|
|
54
|
+
| `PLUGGY_API_BASE` | não | URL base da API (default `https://api.pluggy.ai`) |
|
|
55
|
+
|
|
56
|
+
### Sandbox
|
|
57
|
+
|
|
58
|
+
A Pluggy disponibiliza conectores sandbox (`Pluggy Bank`, `BR · Pluggy Bank`) que funcionam com o mesmo endpoint de produção. Use `list_connectors` com `sandbox: true` para listá-los.
|
|
59
|
+
|
|
60
|
+
## Comandos
|
|
61
|
+
|
|
62
|
+
| Comando | Descrição |
|
|
63
|
+
|---------|-----------|
|
|
64
|
+
| `bun run build` | Compila para Node.js (`dist/index.js`) |
|
|
65
|
+
| `bun run start` | Roda o servidor MCP (`node dist/index.js`) |
|
|
66
|
+
| `bun run test` | Roda os testes automatizados |
|
|
67
|
+
| `bun run inspect` | Abre o MCP Inspector (UI interativa no navegador) |
|
|
68
|
+
|
|
69
|
+
## Créditos
|
|
70
|
+
|
|
71
|
+
Este projeto é um fork estendido do [`@codespar/mcp-pluggy`](https://www.npmjs.com/package/@codespar/mcp-pluggy) (MIT), mantendo toda a funcionalidade original dos 18 tools MCP para a API Pluggy. Agradecimentos à [CodeSpar](https://codespar.dev) pelo trabalho base.
|
|
72
|
+
|
|
73
|
+
### Extensões em relação ao original
|
|
74
|
+
|
|
75
|
+
- `list_investments` — recupera todos os investimentos de um item (`GET /investments`)
|
|
76
|
+
- `get_investment` — recupera um investimento específico por ID (`GET /investments/{id}`)
|
|
77
|
+
- `list_investment_transactions` — recupera todas as transações de um investimento (`GET /investments/{id}/transactions`)
|
|
78
|
+
|
|
79
|
+
## Funcionalidades (18 tools)
|
|
80
|
+
|
|
81
|
+
| Tool | Endpoint Pluggy | Descrição |
|
|
82
|
+
|---|---|---|
|
|
83
|
+
| `list_connectors` | `GET /connectors` | Lista conectores (bancos) |
|
|
84
|
+
| `get_connector` | `GET /connectors/{id}` | Detalhes de um conector |
|
|
85
|
+
| `list_categories` | `GET /categories` | Taxonomia de categorias |
|
|
86
|
+
| `create_connect_token` | `POST /connect_token` | Token para Pluggy Connect |
|
|
87
|
+
| `create_item` | `POST /items` | Nova conexão bancária |
|
|
88
|
+
| `get_item` | `GET /items/{id}` | Detalhes de uma conexão |
|
|
89
|
+
| `update_item` | `PATCH /items/{id}` | Atualiza credenciais/sync |
|
|
90
|
+
| `delete_item` | `DELETE /items/{id}` | Revoga conexão |
|
|
91
|
+
| `list_accounts` | `GET /accounts` | Contas de um item |
|
|
92
|
+
| `get_account` | `GET /accounts/{id}` | Detalhes de uma conta |
|
|
93
|
+
| `list_transactions` | `GET /transactions` | Transações de uma conta |
|
|
94
|
+
| `get_transaction` | `GET /transactions/{id}` | Detalhes de uma transação |
|
|
95
|
+
| `list_identities` | `GET /identity` | Dados cadastrais (CPF, nome, endereço) |
|
|
96
|
+
| `list_investments` | `GET /investments` | Investimentos de um item |
|
|
97
|
+
| `get_investment` | `GET /investments/{id}` | Detalhes de um investimento |
|
|
98
|
+
| `list_investment_transactions` | `GET /investments/{id}/transactions` | Transações de um investimento |
|
|
99
|
+
| `create_payment_intent` | `POST /payments/intents` | Inicia intent de pagamento |
|
|
100
|
+
| `get_payment_intent` | `GET /payments/intents/{id}` | Status do payment intent |
|
|
101
|
+
|
|
102
|
+
## Publicação
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
bun run build
|
|
106
|
+
npm publish
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
`npx pluggy-mcp` funciona em qualquer máquina com Node.js instalado.
|
|
110
|
+
|
|
111
|
+
## Licença
|
|
112
|
+
|
|
113
|
+
MIT — veja [LICENSE](LICENSE).
|