- Home
- MCP servers
- Faraidh
Faraidh
- javascript
0
GitHub Stars
javascript
Language
7 months ago
First Indexed
3 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"mirzaakhena-faraidh-mcp": {
"command": "node",
"args": [
"/path/to/faraidh-mcp/dist/index.js"
]
}
}
}This MCP server provides complete Faraidh (Islamic inheritance) calculations using the KalkulatorFaraidh library. It handles dhawi al-furud, residual heirs, special cases like Aul and Radd, and validates results according to Islamic law, exposing a set of commands to manage cases and generate detailed reports.
How to use
Connect to the Faraidh MCP server from your MCP client to perform end-to-end inheritance calculations. You can add new cases, run instant computations, generate detailed reports, and view or modify stored cases. The server supports templates for common family scenarios and direct calculations without saving data.
How to install
Prerequisites: ensure Node.js and npm are installed on your system. You will also need a working MCP client to interact with the server.
Steps to install and run the server:
# Step 1: Install dependencies
npm install
# Step 2: Build the project
npm run build
# Step 3: Start the server
npm start
Configuration and integration
Integrate the Faraidh MCP server with your MCP configuration by adding its runtime entry. The example below shows how to register a local stdio server that runs the Node.js entry point.
{
"mcpServers": {
"faraidh_mcp": {
"command": "node",
"args": [
"/path/to/faraidh-mcp/dist/index.js"
]
}
}
}
Additional usage notes
Use the provided template cases to quickly simulate common family structures, or create your own cases manually. You can compute results directly, save cases for later edits, and generate comprehensive reports for documentation or auditing.
Troubleshooting
If you run into issues, verify that the necessary runtime file (faraidh-id.js) is located at the project root. Rebuild before starting if you have made changes to the source. Check logs for error details and ensure your environment meets the required Node.js/npm versions.
Notes on validation and errors
The server validates input using a robust schema and provides clear Indonesian error messages to help you correct data issues. Validation rules include ensuring total wealth is greater than zero, the will (wasiat) does not exceed one-third of total assets, and that there is at least one eligible heir.
Security considerations
Run the MCP server in a trusted environment and avoid exposing detailed financial data publicly. Use appropriate access controls and monitor logs for unusual activity.
Notes on templates and tools
Templates provide ready-made scenarios such as a simple family with a spouse and children, a case with only daughters, or a case with no descendants. The server supports a range of tools to manage cases, compute distributions, and generate reports as described in the available feature set.
Available tools
tambah-kasus
Add a new faraidh case with all required fields and heirs to the server for later processing.
hitung-warisan
Compute the inheritance distribution for a stored faraidh case.
buat-laporan
Generate a detailed report of the inheritance distribution for a case.
hitung-langsung
Perform an immediate calculation without saving the case data.
laporan-langsung
Produce a direct report without persisting the case.
daftar-kasus
List all stored faraidh cases available for review.
lihat-kasus
Show detailed information for a specific case by its ID.
hapus-kasus
Remove a stored case by its ID from the system.
update-kasus
Update existing case data with new details or corrections.
template-kasus
Apply predefined template cases to quickly configure common scenarios.
validasi-data
Validate assets and heirs data before calculations.