MX

Mifos X

Created 6 months ago

Mifos X - AI - Model Context Protocol (MCP) for accessing financial data.

development documentation public

What is Mifos X?

A MCP server for the Mifos X Open Source Banking useful for managing clients, loans, savings, shares, financial transactions and generating financial reports.

Documentation

Mifos X - AI - Model Context Protocol (MCP)

This project provides Model Context Protocol (MCP) for the Mifos X Ecosystem, enabling AI agents to access financial data and operations. Implementations is available in Java (Quarkus).

MCP Developer Tools

Use the MCP Inspector to test and debug your server:

npx @modelcontextprotocol/inspector

This starts a local web UI to connect to your MCP server via STDIO or SSE.

Getting Started# 1. Choose Your Implementation\n\n#### Java (Quarkus)

Prerequisites: JDK 17+, Maven

Steps:

  1. Configure environment variables in your shell or IDE:
export MIFOSX_BASE_URL="https://your-fineract-instance"
export MIFOSX_BASIC_AUTH_TOKEN="your_api_token"
export MIFOS_TENANT_ID="default"
  1. Run via JBang (for quick execution):
jbang --quiet org.mifos.community.ai:mcp-server:1.0.0-SNAPSHOT:runner
  1. (Optional) Build a native executable:
./mvnw package -Dnative ./target/mcp-server-1.0.0-SNAPSHOT-runner

Configuration

All implementations require the following environment variables:

Variable Description
FINERACT_BASE_URL Base URL of your Fineract instance
FINERACT_BASIC_AUTH_TOKEN API authentication token
FINERACT_TENANT_ID Tenant identifier (default: default)

Note: Java uses MIFOSX_ prefixed variables (e.g., MIFOSX_BASE_URL).

Building Native Executables (Java Only)

For Java (Quarkus), create a native executable:

./mvnw package -Dnative -Dquarkus.native.container-build=true ./target/mcp-server-1.0.0-SNAPSHOT-runner

Testing with MCP Inspector

  1. Start your MCP server (Python/Java/Node.js).
  2. Run the inspector:
npx @modelcontextprotocol/inspector
  1. Connect to the server using the STDIO transport.

Contributing

  • Java: Extend src/main/java/org/mifos/community/ai/... for new endpoints.

Contact

Guides

Key Features:

  • Standardized API access via fineract:// URIs
  • MCP-compliant with STDIO/SSE transports
  • Environment-agnostic configuration

Server Config

{
  "mcpServers": {
    "mifos-x-server": {
      "command": "npx",
      "args": [
        "mifos-x"
      ]
    }
  }
}

Links & Status

Repository: github.com
Hosted: No
Global: Yes
Official: Yes

Project Info

Hosted Featured
Created At: May 23, 2025
Updated At: Aug 07, 2025
Author: Apache Fineract Community
Category: community
Tags:
development documentation public