About mcp-sicoob
mcp-sicoob is an MCP server for Sicoob, a Brazilian cooperative bank network, covering Pix, Cobrança boleto and SPB APIs. It is in alpha, and endpoint paths are still marked for verification against the portal spec. Every call requires both OAuth2 client credentials and mTLS.
Key features
- 01Immediate and due-date Pix charge tools
- 02DICT key lookup, registration and deletion
- 03Boleto issuance, retrieval and cancellation
- 04SPB account balance query
- 05OAuth2 token caching and mTLS certificate loading
Use cases
- 01Generate Pix charges with QR codes and check their status
- 02Verify DICT key owner data before sending a Pix payment
- 03Issue and cancel boletos from an MCP client
MCP support
This is an MCP server that exposes 13 tools to MCP clients for calling Sicoob Developers Portal Pix, Cobrança and SPB endpoints.
Configuration
Local server config is the same for every client. Copy it into your client’s MCP config file.
npx -y @codespar/mcp-sicoobSICOOB_CLIENT_IDSicoob OAuth client_id issued via the Developers Portal after cooperative onboarding.SICOOB_CLIENT_SECRETSecretSicoob OAuth client_secret.SICOOB_CERT_PATHAbsolute path to the mTLS client certificate (.crt or .pem). BACEN mandates mTLS for Pix v2.SICOOB_KEY_PATHSecretAbsolute path to the mTLS private key (.key or .pem).SICOOB_ENVEnvironment: 'sandbox' or 'production'. Defaults to 'sandbox'.Local servers need a runtime on your machine (e.g. Node.js 18+). Config file locations differ by client; see your client’s docs.
Tools
13Saved tool list · updated 2w ago
This tool takes no parameters.
Details
From the project README@codespar/mcp-sicoob
MCP server for Sicoob — Brazil's largest cooperative bank network.
Sicoob is consistently a top-4 PSP by Pix volume in Brazil. The Sistema de Cooperativas de Crédito do Brasil aggregates hundreds of regional cooperatives behind a single Developers Portal exposing Pix, Cobrança (boleto), and SPB APIs.
Status: alpha (0.1.0-alpha.1)
Sicoob's Developers Portal is gated by cooperative onboarding. The endpoint paths in this server are best-guesses based on (a) BACEN Pix v2 standard paths, (b) Sicoob's public documentation snippets, and (c) conventions shared across Itaú / Bradesco / BB. Every unverified path is flagged TODO(verify) in the source.
Pin to exact versions during 0.1.x; paths will be corrected to match the portal spec once an onboarded cooperative member can validate.
Tools (13)
| Tool | Purpose |
|---|---|
get_oauth_token | Mint or return a cached OAuth2 client_credentials bearer token for the Sicoob Developers Portal. |
create_pix_cob | Create an immediate Pix charge (cob) with QR code. |
get_pix_cob | Retrieve an immediate Pix charge by its txid. |
list_pix_cob | List immediate Pix charges (cob) registered by the merchant within a date range. |
create_pix_cobv | Create a Pix charge with due date (cobv) — boleto-like Pix payable on or after a due date with optional fin... |
get_pix_cobv | Retrieve a due-date Pix charge (cobv) by its txid. |
lookup_dict_key | Resolve a DICT key (CPF, CNPJ, email, phone, EVP) to the owner's account data before sending a Pix. |
register_dict_key | Register a DICT key (CPF, CNPJ, email, phone, or EVP) on a Sicoob account owned by the cooperative member. |
delete_dict_key | Delete a DICT key owned by the cooperative member. |
create_boleto | Issue a boleto via Sicoob Cobrança. |
get_boleto | Retrieve a boleto by its Sicoob identifier (id or nosso_numero). |
cancel_boleto | Cancel (baixa) an outstanding boleto before payment. |
get_account_balance | Query the merchant cooperative account balance via Sicoob SPB. |
Install
npm install @codespar/[email protected]
Environment
SICOOB_CLIENT_ID="..." # OAuth client_id from Sicoob's Developers Portal
SICOOB_CLIENT_SECRET="..." # OAuth client_secret
SICOOB_CERT_PATH="/abs/path/to/client.crt" # mTLS client certificate
SICOOB_KEY_PATH="/abs/path/to/client.key" # mTLS private key
SICOOB_ENV="sandbox" # or "production" (default: sandbox)
Authentication
Two factors are both required on every call:
- OAuth2
client_credentials— the server calls the token endpoint, caches the bearer until ~60s before expiry, and attachesAuthorization: Bearer <token>to downstream calls. - mTLS — BACEN mandates mutual TLS for Pix v2, and Sicoob enforces it across product families. The server loads the client certificate and private key from the paths you set, builds a Node
https.Agent, and routes every request through it.
The cert + key bundle is issued by Sicoob's Developers Portal after cooperative onboarding and is distinct from the OAuth credentials.
Run
# stdio (default)
npx @codespar/mcp-sicoob
# HTTP transport
MCP_HTTP=true MCP_PORT=3000 npx @codespar/mcp-sicoob
Caveats
- Paths are unverified. See the
TODO(verify)markers insrc/index.ts. Onboarded cooperatives should validate against their portal-issued OpenAPI spec and open a PR. - Sandbox host is a guess. Sicoob issues a sandbox subdomain per cooperative; override by editing
BASE_URLif your provisioned sandbox URL differs.
Enterprise
Need governance, budget limits, and audit trails for agent payments? CodeSpar Enterprise adds policy engine, payment routing, and compliance templates on top of these MCP servers.
License
MIT
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.