使用说明

项目简介

本项目实现了一个 MCP 服务器，允许 LLM 应用与 Apache Fineract 金融平台进行交互。它将诸如检索客户和贷款信息、搜索客户、创建贷款申请等功能作为 MCP 资源和工具公开，方便LLM应用集成金融服务能力。

主要功能点

资源访问: 将 Apache Fineract 中的客户 (clients) 和贷款 (loans) 数据以 MCP 资源的形式暴露，允许LLM应用通过标准化的 URI 访问。
工具调用: 提供了丰富的工具集，包括：
- 'search_clients': 根据姓名、ID等信息搜索客户。
- 'create_client': 在系统中创建新客户。
- 'get_loan_details': 获取指定贷款的详细信息。
- 'create_loan_application': 创建新的贷款申请。
- 'approve_loan': 审批待处理的贷款申请。
- 'disburse_loan': 发放已审批的贷款。
传输协议: 使用 STDIO (标准输入/输出) 传输协议与 MCP 客户端通信。

安装步骤

安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node 包管理器)。

克隆仓库: 使用 git 命令克隆仓库到本地：

git clone https://github.com/openMF/mcp-mifosx.git

进入 Node.js 目录: 导航到仓库的 'nodejs' 目录：
```
cd mcp-mifosx/nodejs
```
安装依赖: 运行 npm 命令安装项目依赖：
```
npm install
```

配置环境变量: 在 'nodejs' 目录下创建 '.env' 文件，并根据你的 Apache Fineract 实例配置以下环境变量：

FINERACT_BASE_URL=https://sandbox.mifos.community/fineract-provider/api/v1  # 你的 Fineract API URL，如果使用沙箱环境则无需修改
FINERACT_USERNAME=mifos  # 你的 Fineract 用户名
FINERACT_PASSWORD=password # 你的 Fineract 密码
FINERACT_TENANT_ID=default # 你的 Fineract 租户 ID

服务器配置

以下 JSON 配置信息用于 MCP 客户端连接此 MCP 服务器。请将此配置添加到你的 MCP 客户端配置中。

{
  "serverName": "MifosX-MCP-Server",
  "command": "node",
  "args": [
    "nodejs/src/index.js"
  ],
  "transport": "stdio"
}

'serverName': 自定义的服务器名称，用于在 MCP 客户端中标识此配置。
'command': 运行服务器的命令，这里使用 'node' 命令来执行 JavaScript 文件。
'args': 传递给 'node' 命令的参数，指向服务器的入口文件 'nodejs/src/index.js'。
'transport': 指定 MCP 客户端与服务器通信的传输协议，这里使用 'stdio' (标准输入/输出) 协议。

基本使用方法

启动 MCP 服务器: 在 MCP 客户端中配置并启动 "MifosX-MCP-Server"。MCP 客户端会根据上述配置运行 'node nodejs/src/index.js' 命令来启动 MCP 服务器。
连接 Fineract 实例: 服务器启动后，将根据 '.env' 文件中的配置连接到你的 Apache Fineract 实例。
探索资源和工具: 在 MCP 客户端中，你可以浏览由服务器提供的资源 (例如 'fineract://clients', 'fineract://loans') 和工具 (例如 'search_clients', 'create_loan_application')。
调用工具: 选择合适的工具，并根据工具的参数描述在 MCP 客户端中提供参数值，即可调用工具执行相应的金融操作。例如，调用 'search_clients' 工具并输入客户姓名关键词，即可搜索 Fineract 系统中的客户信息。

注意事项

首次使用或配置变更后，请务必重启 MCP 服务器以应用新的配置。
确保 '.env' 文件中的 Fineract 访问凭据正确，并妥善保管，避免泄露。
本 MCP 服务器仅实现了部分 Fineract API 功能，如需更多功能请根据 MCP 协议规范进行扩展。

关键词