Metadata-Version: 2.3
Name: mcp_ohmy_sql
Version: 0.1.1
Summary: A powerful Model Context Protocol (MCP) server that provides universal SQL database connectivity with intelligent query optimization, schema introspection, and built-in safety features for AI assistants.
License: AGPL-3.0-or-later
Author: Sanhe Hu
Author-email: husanhe@email.com
Maintainer: Sanhe Hu
Maintainer-email: husanhe@email.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: auto
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
Requires-Dist: Sphinx (>=7.4.7,<8.0.0) ; extra == "doc"
Requires-Dist: build (>=1.2.1,<2.0.0) ; extra == "dev"
Requires-Dist: docfly (==3.0.0) ; extra == "doc"
Requires-Dist: furo (==2024.8.6) ; extra == "doc"
Requires-Dist: ipython (>=8.18.1,<8.19.0) ; extra == "doc"
Requires-Dist: nbsphinx (>=0.8.12,<1.0.0) ; extra == "doc"
Requires-Dist: pygments (>=2.18.0,<3.0.0) ; extra == "doc"
Requires-Dist: pytest (>=8.2.2,<9.0.0) ; extra == "test"
Requires-Dist: pytest-cov (>=6.0.0,<7.0.0) ; extra == "test"
Requires-Dist: rich (>=13.8.1,<14.0.0) ; extra == "dev"
Requires-Dist: rstobj (==1.2.1) ; extra == "doc"
Requires-Dist: sphinx-copybutton (>=0.5.2,<1.0.0) ; extra == "doc"
Requires-Dist: sphinx-design (>=0.6.1,<1.0.0) ; extra == "doc"
Requires-Dist: sphinx-jinja (>=2.0.2,<3.0.0) ; extra == "doc"
Requires-Dist: twine (>=6.0.0,<7.0.0) ; extra == "dev"
Requires-Dist: wheel (>=0.45.0,<1.0.0) ; extra == "dev"
Project-URL: Changelog, https://github.com/MacHu-GWU/mcp_ohmy_sql-project/blob/main/release-history.rst
Project-URL: Documentation, https://mcp-ohmy-sql.readthedocs.io/en/latest/
Project-URL: Download, https://pypi.org/pypi/mcp-ohmy-sql#files
Project-URL: Homepage, https://github.com/MacHu-GWU/mcp_ohmy_sql-project
Project-URL: Issues, https://github.com/MacHu-GWU/mcp_ohmy_sql-project/issues
Project-URL: Repository, https://github.com/MacHu-GWU/mcp_ohmy_sql-project
Description-Content-Type: text/x-rst


.. image:: https://readthedocs.org/projects/mcp-ohmy-sql/badge/?version=latest
    :target: https://mcp-ohmy-sql.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/mcp_ohmy_sql-project/actions/workflows/main.yml/badge.svg
    :target: https://github.com/MacHu-GWU/mcp_ohmy_sql-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/mcp_ohmy_sql-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/mcp_ohmy_sql-project

.. image:: https://img.shields.io/pypi/v/mcp-ohmy-sql.svg
    :target: https://pypi.python.org/pypi/mcp-ohmy-sql

.. image:: https://img.shields.io/pypi/l/mcp-ohmy-sql.svg
    :target: https://pypi.python.org/pypi/mcp-ohmy-sql

.. image:: https://img.shields.io/pypi/pyversions/mcp-ohmy-sql.svg
    :target: https://pypi.python.org/pypi/mcp-ohmy-sql

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/mcp_ohmy_sql-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/mcp_ohmy_sql-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://mcp-ohmy-sql.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/mcp_ohmy_sql-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/mcp_ohmy_sql-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/mcp_ohmy_sql-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/mcp-ohmy-sql#files


Welcome to ``mcp_ohmy_sql`` Documentation
==============================================================================
.. image:: https://mcp-ohmy-sql.readthedocs.io/en/latest/_static/mcp_ohmy_sql-logo.png
    :target: https://mcp-ohmy-sql.readthedocs.io/en/latest/

``mcp_ohmy_sql`` is a state-of-the-art SQL Model Context Protocol (MCP) server built on SQLAlchemy that provides universal database connectivity with intelligent query optimization, configurable tool exposure, and built-in safeguards against excessive data loads to LLMs. It supports schema introspection, query execution with result pagination, data export capabilities, and fine-grained access control (upcoming), making it the ideal bridge between AI assistants and SQL databases while ensuring performance, security, and flexibility across all major database engines.


.. _install:

Install
------------------------------------------------------------------------------

``mcp_ohmy_sql`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install mcp-ohmy-sql

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade mcp-ohmy-sql

