Scansca Documentation¶
Welcome to the Scansca documentation. Scansca is a self-hostable server that connects Large Language Model (LLM) clients with database systems through the Model Context Protocol (MCP).
What is Scansca?¶
Scansca allows you to:
- Connect LLMs to your databases for natural language database interactions
- Query multiple database systems through a unified interface
- Automate database tasks and monitoring through a simple API
- Gain deeper insights from your data without complex query writing
Documentation Contents¶
Getting Started¶
- Getting Started Guide - Setup and run Scansca
- Makefile Reference - Reference for all available make commands
API Reference¶
- API Documentation - Complete API reference
Architecture and Design¶
- System Architecture - Overview of Scansca's architecture
- MCP Integration - How Scansca implements the Model Context Protocol
- Technology Stack - Technologies used in Scansca
- Use Cases - Common use cases for Scansca
- Development Plan - Roadmap for Scansca development
Core Features¶
Scansca provides several key features:
- Multi-Database Support: Connect to PostgreSQL, MySQL, SQLite, and more
- Schema Introspection: Automatically discover and expose database structures
- MCP Protocol: Seamless integration with LLM clients
- HTTP API: Comprehensive RESTful interface for all operations
Quick Links¶
Contributing¶
Contributions to both the documentation and the codebase are welcome. Please feel free to submit a Pull Request or open an Issue for any improvements or suggestions.