@smoothless/appwrite-db-docs
v0.1.1
Published
MCP server that generates database documentation from appwrite.config.json files
Downloads
11
Maintainers
Readme
Appwrite DB Documentation MCP Server
An MCP (Model Context Protocol) server that automatically generates database documentation from Appwrite configuration files.
Overview
This MCP server scans your codebase for appwrite.config.json files, extracts database schema information, and generates a DB.md file with a clean summary of your database structure.
Features
- 🔍 Auto-discovery: Locates
appwrite.config.jsonfiles in your project - 📊 Schema parsing: Extracts database collections, attributes, and relationships
- 📝 Clean documentation: Generates simple, readable markdown tables
- 🔄 Format support: Handles both modern and legacy Appwrite config formats
Installation
Via MCP Registry (Recommended)
Add this server to your Claude Desktop MCP settings:
{
"mcpServers": {
"appwrite-db-docs": {
"command": "npx",
"args": ["@smoothless/appwrite-db-docs"],
"env": {}
}
}
}Manual Installation
npm install @smoothless/appwrite-db-docsThen add to your MCP settings:
{
"mcpServers": {
"appwrite-db-docs": {
"command": "node",
"args": ["node_modules/@smoothless/appwrite-db-docs/dist/index.js"],
"env": {}
}
}
}Usage
Once configured, you can use the server in Claude Desktop by asking it to generate database documentation:
- "Generate database documentation for my project"
- "Create a DB.md file from my Appwrite config"
- "Document my database schema"
Tools Provided
generate_db_docs: Finds appwrite.config.json and generates DB.md documentationproject_root(required): Root directory to search for appwrite.config.jsonoutput_path(optional): Custom path for DB.md output
Example Output
The server generates clean, simple documentation like this:
# Database Structure
- **Name**: my_database
- **ID**: `abc123`
| Table | Columns | Row Security |
|-------|---------|--------------|
| **users** | name (string), email (string), created_at (datetime) | ✅ |
| **posts** | title (string), content (string), user_id (relationship) | ❌ |Requirements
- Node.js 18.0.0 or higher
- Appwrite project with
appwrite.config.jsonfile
Development
git clone https://github.com/modelcontextprotocol/servers.git
cd servers/src/appwrite-db-docs
npm install
npm run build
npm run devLicense
MIT
