fineract-agent-skill

Apache Fineract Agent Skill

Provides 55+ tools across 9 domains for full-lifecycle banking operations against an Apache Fineract instance.

Prerequisites

1. Verify the environment file exists at agent-skill/mifos-agent/.env. If missing, copy agent-skill/mifos-agent/.env.example and populate the credentials. See references/environment-config.md for variable descriptions.
2. Verify the Python package is installed: pip install -e agent-skill/mifos-agent/.[dev]. If import errors occur, re-run this command.

Step 1: Initialize the Client

1. Import and instantiate the Fineract client:

   from fineract_skill import FineractClient
   client = FineractClient()
   

2. Verify connectivity by calling client.ping(). If the result contains "status": "error", inspect the error message and check the .env configuration.

Step 2: Discover Available Tools

1. Import the tool registry:

   from fineract_skill import list_tools, get_tool
   

2. To list all tools: list_tools(). To filter by domain: list_tools(domain="loans").
3. Supported domains: clients, loans, savings, groups, accounting, staff, products, charges, reports.
4. For the full tool catalog with parameter schemas, read references/tool-catalog.md.

Step 3: Execute a Tool

1. Look up the tool by name: tool = get_tool("search_clients").
2. Call the handler, passing the client as the first argument followed by the required parameters:

   result = tool.handler(client, name_query="John")
   

3. All tools return a standardised envelope:
   • Success: {"ok": True, "data": {...}}
   • Failure: {"ok": False, "error": "..."}
4. If result["ok"] is False, read the error field. Common causes: invalid IDs, missing required fields, or authentication failures.

Step 4: Export Schemas for Agent Frameworks

1. For OpenAI function-calling format:

   from fineract_skill.tools import get_openai_tools
   schemas = get_openai_tools()
   

2. For MCP-compatible format:

   from fineract_skill.tools import get_mcp_tools
   schemas = get_mcp_tools()
   

3. For the static JSON schema template, read assets/tool-schema-template.json.