Openbudget

🚀 OpenBudget MCP Server

An MCP server that provides access to the OpenBudget API, allowing you to query and search various budget-related datasets.

🚀 Quick Start

This project offers a FastMCP server for connecting with the Israeli Open Budget data interface. It serves as a bridge between the OpenBudget API and MCP clients, enabling easy access to budget data, contract information, and supporting materials.

This achievement is entirely due to the excellent work of the OpenBudget/BudgetKey team.

✨ Features

• Comprehensive access to Israeli government budget data.
• Real-time integration with the OpenBudget API.
• Comprehensive search functionality across multiple data categories.
• Historical budget tracking and analysis.
• Retrieval of contract and payment information.
• An easy-to-use MCP interface for client applications.

📦 Installation

Requirements

• Python 3.10 or higher.
• uv package manager.

Steps

git clone <repository-url>
cd OpenBudget-mcp
uv venv
.venv\Scripts\activate
uv pip install -r pyproject.toml
uv lock

💻 Usage Examples

Basic Usage

For Visual Studio Code (used with Copilot):

Navigate to vscode/mcp.json and replace {YOUR-LOCAL-PATH} with the path where you cloned the repository. VSCode should automatically detect your server. If it fails, ensure that the MCP & MCP.Discovery settings in VSCode are enabled (check at vscode://settings/mcp). Also, make sure the proxy mode is enabled in your VSCode Copilot.

For Claude AI Assistant:

fastmcp install server.py

For testing with MCP Inspector (for more information, visit MCP Inspector):

fastmcp dev server.py

📚 Documentation

Available Datasets

The following datasets are available:

• Budget item data
• Revenue item data
• Subsidy information data
• Contract data
• Entity data
• Budget revision request data
• Budget revision transaction data

MCP Tools

get_dataset_info

Retrieve the structural information of a dataset, including its fields and database schema.

search_dataset

Perform a full-text search in the dataset.

query_dataset

Execute an SQL query on the dataset.

MCP Resources

available_datasets

Get a list of all available datasets.

Error Handling

The tools will return appropriate error messages in the following situations:

• Invalid dataset name.
• Invalid SQL query.
• Network connection issues.
• Resource not found.

API Documentation

For detailed information about the API, please refer to the OpenAPI specification file: openapi.yaml

📄 License

This project is maintained by [OpenBudget], aiming to provide transparent and accessible budget data. For more information or support, please visit our official website or contact the support team.