ORMCP

by softwaretree

Not rated
GitHub

About

ORMCP provides a curated, object-oriented, MCP-compliant view of relational data in any JDBC-compliant database (e.g., PostgreSQL, MySQL, Oracle, SQL Server, DB2, SQLite) — improving reasoning clarity, reducing token usage, and establishing a clear governance boundary.

Details

Author
softwaretree
Categories
Database, Other

Setup

Install ORMCP in your MCP client (Claude Desktop, Cursor, Windsurf, and others).

Repository: https://github.com/softwaretree/ormcp-docs

Follow the installation instructions in the repository README, then restart your MCP client.

A Model Context Protocol (MCP) Server to connect your AI applications to relational databases

ORMCP Server enables AI LLMs and MCP clients to easily exchange object-oriented data (in JSON format) with any relational database using the MCP standard protocol.

ORMCP Server makes your relational data AI ready.

ORMCP Serveris currently inBeta, and we are offering early access to users who want to check the software, provide feedback, and help us ensure the product meets the highest quality standards. This Beta version isnotintended for commercial use, and it is provided fortesting purposes only.

- What is MCP?
-
Features
-
How It Works
-
Quick Start
- Platform-Specific Guides — 🍎
macOS· 🪟Windows· 🐧Linux
-
Installation
-
Gilhari Microservice Setup
-
Configuration
-
Starting the Server
-
Client Configuration
-
Usage Examples
-
MCP Tools Reference
-
Troubleshooting
-
Development
-
Contributing
-
License
-
Support & Resources

The Model Context Protocol (MCP) is an open standard that provides a unified way for AI models to interact with external tools and data sources. It standardizes communication, making it easier to integrate LLMs into complex workflows without building custom API integrations for every use case.

Learn more at theOfficial MCP Website.

- ✅ Standardized Interface:Fully compliant with the Model Context Protocol (MCP) specification
- 🌐 Database Agnostic:Works with any JDBC-compliant database (e.g., PostgreSQL, MySQL, Oracle, SQL Server, DB2, SQLite)
- ↔️ Bi-directional Data Flow:Seamless AI ↔ Database communication with optional support for only READONLY operations
- 🔄 Object-Relational Mapping (ORM):JSON object operations (CRUD) transparently mapped to relational data
- 🔒 Secure Data Access: Domain model-specific operations promote data protection
- 🧾 Declarative ORM Specification:Intuitive, non-intrusive, and flexible ORM specification based on a simple grammar
- 🕸️ Support for Complex Object Modeling:Including one-to-one, one-to-many, and many-to-many relationships, and path-expressions
- 🖇️ Flexible Queries:Deep and Shallow queries, Various operational directives similar toGraphQLcapabilities to refine the shape and scope of returned objects
- 🚀 Highly Optimized and Lightweight Mapping Engine:Connection pooling, Prepared statements, Optimized SQL statements, Minimal database trips, Caching of metadata
- 🔌 Compatible with Existing Data and Databases:Works with existing schemas and data in any database; Does not require any native JSON data type
- 📚 Comprehensive Documentation:Detailed User manual and README files, API documentation, sample apps
- ☁️ Cloud Agnostic:Deploy anywhere with Docker support
- ⚡ High Performance:Built on versatile Gilhari microservice architecture and optimised ORM engine
- 🛡️ Robust Error Handling:Clear error messages and recovery mechanisms
- 📈 Scalable:Handles multiple concurrent requests efficiently; Scalable Docker deployment

+---------------------+ +----------------------+ +-------------------------+ | AI App / LLM Client | <---> | ORMCP Server | <---> | Relational Database | | (MCP-compliant tool)| | (MCP + Gilhari) | | (Postgres, MySQL, etc.) | +---------------------+ +----------------------+ +-------------------------+ | | | | JSON (via MCP Tools) | | |------------------------------->| | | | ORM + JDBC | | |-------------------------------->| | | | | JSON result (MCP format) | | |<-------------------------------| |

Important:The AI application (LLM client) translates natural language into MCP tool calls. ORMCP Server then translates these MCP tool calls into REST API calls to Gilhari.

ORMCP Serverbridges the gap between modern AI applications and relational databases through:

- MCP Protocol: Standardized AI-to-tool communication
- Gilhari: Integration layer with relational databases via ORM and JDBC
- JSON Mapping: Transparent object-relational mapping

New to ORMCP? Jump straight to your platform-specific guide for a streamlined setup:🍎macOS· 🪟Windows· 🐧Linux

The sections below cover all platforms together as a complete reference.

- Define lightweight object models for your relevant data
- Write a declarative ORM specification for those models in a text file using a simple (JDX) grammar

- Add models, ORM specification, and JDBC driver to a Dockerfile
- Build the Gilhari Docker image

- Connect ORMCP to the Gilhari microservice
- Start Gilhari, then ORMCP
- Interact with scoped relational data in an intuitive, object-oriented way using an AI Agent or MCP client

- Python 3.12+
- Docker (for Gilhari microservice)
- JDBC driver for your target database

Platform-specific guideswith step-by-step install instructions for your OS:macOS·Windows·Linux

ORMCP Server is available on public PyPI. No account, token, or beta-access request is needed to install it:

pip install ormcp-server # Verify installation pip show ormcp-server

📌 Linux/Mac Users:Modern Linux distributions and macOS may require virtual environments. See yourplatform guideor thetroubleshooting guideif you get "externally-managed-environment" errors.

# Create virtual environment (recommended on Linux/Mac) python3 -m venv .venv # Activate — Linux/Mac: source .venv/bin/activate # Activate — Windows (Command Prompt): .venv\Scripts\activate # Activate — Windows (PowerShell): .venv\Scripts\Activate.ps1 # Install pip install ormcp-server

If you have an existing Gemfury tokenfrom an earlier beta install, it will no longer work — Gemfury access has been discontinued. Usepip install ormcp-server, which pulls from public PyPI directly.

Iformcp-servercommand is not found after installation:

Add the Python executable directory to your PATH. See your platform guide for details:macOS·Windows·Linux

See detailed setup inGilhari Microservice Setupsection below.

Note:A complete working example is available in a separate repository:gilhari_example1

IMPORTANT:Docker is required for building and running a Gilhari microservice —[Get Dockerif not already installed on your machine

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.