What is Openbanking Mcp

openbanking-mcp is a simple demo server implementing the Model Context Protocol (MCP) to expose banking resources such as accounts and transactions.

Use cases

Use cases include retrieving account information, managing transactions for specific accounts, and testing API interactions through the MCP Inspector.

How to use

To use openbanking-mcp, install the necessary dependencies with ‘npm install’, then run the server in development mode using ‘npm run dev’ or in production mode with ‘npm run build’ followed by ‘npm run start’. You can interact with the server using the MCP Inspector tool.

Key features

Key features include account resources with filtering capabilities, transaction resources linked to accounts, tools for creating new accounts and transactions, and RESTful URI templates compliant with RFC6570.

Where to use

openbanking-mcp can be used in the banking and financial technology sectors to demonstrate and test the access and management of account and transaction data.

Banking MCP Server

This project implements a Model Context Protocol (MCP) server that exposes banking resources including Accounts and Transactions.

Features

• Account resources with filtering capabilities
• Transaction resources linked to accounts with comprehensive filtering
• Tools to create new accounts and transactions
• RESTful URI templates following RFC6570

Getting Started

Prerequisites

• Node.js 18+
• npm

Installation

npm install

Running the server

Development mode:

npm run dev

Production mode:

npm run build
npm run start

Testing with MCP Inspector

You can test and interact with the MCP server using the MCP Inspector tool:

npx @modelcontextprotocol/inspector node dist/index.js

This will launch the MCP Inspector UI in your browser, allowing you to explore the available resources, test API calls, and verify the implementation.

Resources

Accounts

• accounts - Returns all accounts
• accounts/{id} - Returns a specific account by ID

Transactions

• accounts/{id}/transactions - Returns all transactions for a specific account

Tools

Create Account

Creates a new bank account.

Parameters:

• name: Account holder name
• type: “checking”, “savings”, or “credit”
• initialBalance: Starting balance (optional, defaults to 0)

Create Transaction

Creates a new transaction for an existing account.

Parameters:

• accountId: ID of the account
• amount: Transaction amount (positive for deposits/incoming transfers, negative for withdrawals/payments)
• transactionType: “deposit”, “withdrawal”, “transfer”, or “payment”
• recipient: Recipient name (optional)
• sender: Sender name/account (optional)
• description: Transaction description

Example Usage

Get all accounts:

accounts

Get a specific account:

accounts/acc-001

Get all transactions for account “acc-001”:

accounts/acc-001/transactions

Implementation Details

This MCP server follows the RFC6570 URI Template specification and is built using the MCP TypeScript SDK.

Completion Support

The server provides autocompletion for resource parameters:

• Account IDs in specific account detail paths (accounts/{id})
• Account IDs in transaction resource paths (accounts/{id}/transactions)

This helps LLMs accurately construct valid resource URLs by providing possible values for the account ID parameter.

Development

Local Development

# Install dependencies
npm install

# Run in development mode with auto-reload
npm run dev

# Type check without emitting files
npm run typecheck

# Lint code
npm run lint

# Build for production
npm run build

# Run production build
npm run start

Debugging with MCP Inspector

The MCP Inspector is a powerful tool for debugging and exploring your MCP server implementation:

# Run against the built version
npx @modelcontextprotocol/inspector node dist/index.js

# Run against the development version (using ts-node)
npx @modelcontextprotocol/inspector npm run dev

MCP Inspector features:

• Interactive UI to browse available resources and tools
• Test completions and resource lookups
• View request/response logs
• Execute tool calls
• Validate your MCP implementation against the specification

CI/CD

This project uses GitHub Actions for continuous integration, with workflows that:

• Run on every push to main and pull requests
• Build and test the project on multiple Node.js versions (18.x, 20.x)
• Perform type checking and linting
• Run security scans with npm audit
• Check dependencies for vulnerabilities

The workflow is defined in .github/workflows/ci.yml.

Project Structure

• src/index.ts - Main server implementation
• dist/ - Compiled JavaScript output
• .github/workflows/ - CI/CD configuration