feat: add database/collection/storage enhancements, file download, array attributes, remove messaging tools
This commit is contained in:
72
README.md
72
README.md
@@ -6,33 +6,32 @@
|
||||
|
||||
|
||||
|
||||
**Transform Claude into your intelligent Appwrite management assistant**
|
||||
*16 optimized tools • Core Appwrite operations • Context-efficient design • Production-ready*
|
||||
**Transform Claude into your intelligent Appwrite management assistant**
|
||||
*12 optimized tools • Core Appwrite operations • Context-efficient design • Production-ready*
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
A **context-optimized Model Context Protocol (MCP)** server that provides Claude with essential Appwrite integration. This version focuses on core functionality with action-based combined tools, offering database operations, user management, storage, messaging, and team management in an efficient package designed to stay under MCP context limits.
|
||||
A **context-optimized Model Context Protocol (MCP)** server that provides Claude with essential Appwrite integration. This version focuses on core functionality with action-based combined tools, offering database operations, user management, storage, and team management in an efficient package designed to stay under MCP context limits.
|
||||
|
||||
## 🚀 Features
|
||||
|
||||
**🎯 Core Appwrite Operations:**
|
||||
- **Database Management** - Create, list, and delete databases
|
||||
- **Collection Operations** - Full collection lifecycle management
|
||||
- **Document CRUD** - Complete document operations with bulk support
|
||||
- **Database Management** - Create, get, list, update, and delete databases with enabled status
|
||||
- **Collection Operations** - Full collection lifecycle with document security and search support
|
||||
- **Document CRUD** - Complete document operations with bulk support and advanced queries
|
||||
- **User Management** - User operations including bulk processing and preferences
|
||||
- **Storage Management** - Bucket and file operations with URL generation
|
||||
- **Team Management** - Complete team administration
|
||||
- **Messaging Service** - Messages, topics, and subscriber management
|
||||
- **Attribute & Index Management** - Schema management with bulk operations
|
||||
- **Storage Management** - Complete bucket operations with advanced configuration (file size limits, allowed extensions, compression, encryption, antivirus) and file upload/download
|
||||
- **Team Management** - Team CRUD operations
|
||||
- **Attribute & Index Management** - Schema management with array support and bulk operations
|
||||
- **Health Monitoring** - System health checks
|
||||
|
||||
**⚡ Action-Based Design:**
|
||||
- **Single tools handle multiple operations** using action parameters
|
||||
- **Bulk operations integrated** into respective categories
|
||||
- **Context-optimized** - 88% fewer tools than original
|
||||
- **Maintained functionality** - All core features preserved
|
||||
- **Context-optimized** - Efficient tool design for reduced token usage
|
||||
- **Advanced features** - Document security, file download, bucket encryption, array attributes
|
||||
|
||||
## 📦 Quick Start
|
||||
|
||||
@@ -167,14 +166,14 @@ Once integrated, you should be able to use commands like:
|
||||
- "Create a new user with email test@example.com"
|
||||
- "Show me all collections in my database"
|
||||
|
||||
## 🛠️ Available Tools (16 Total)
|
||||
## 🛠️ Available Tools (12 Total)
|
||||
|
||||
<details>
|
||||
<summary><strong>🗄️ Database Operations (1 tool)</strong></summary>
|
||||
|
||||
| Tool | Actions | Description |
|
||||
|------|---------|-------------|
|
||||
| `manage_database` | create, list, delete | Comprehensive database management |
|
||||
| `manage_database` | create, get, list, update, delete | Comprehensive database management with enabled status |
|
||||
|
||||
</details>
|
||||
|
||||
@@ -183,7 +182,7 @@ Once integrated, you should be able to use commands like:
|
||||
|
||||
| Tool | Actions | Description |
|
||||
|------|---------|-------------|
|
||||
| `collection_operations` | create, get, list, update, delete | Complete collection lifecycle management |
|
||||
| `collection_operations` | create, get, list, update, delete | Complete collection lifecycle with document security, enabled status, and search |
|
||||
|
||||
</details>
|
||||
|
||||
@@ -192,7 +191,7 @@ Once integrated, you should be able to use commands like:
|
||||
|
||||
| Tool | Actions | Description |
|
||||
|------|---------|-------------|
|
||||
| `attribute_operations` | create, get, list, update, delete, bulk_create, bulk_delete | Full attribute management with bulk operations |
|
||||
| `attribute_operations` | create, get, list, update, delete, bulk_create, bulk_delete | Full attribute management with array support and bulk operations |
|
||||
|
||||
</details>
|
||||
|
||||
@@ -230,8 +229,8 @@ Once integrated, you should be able to use commands like:
|
||||
|
||||
| Tool | Actions/Description |
|
||||
|------|--------------------|
|
||||
| `bucket_operations` | create, get, list, update, delete |
|
||||
| `file_operations` | get, create, update, delete, list |
|
||||
| `bucket_operations` | create, get, list, update, delete - with advanced configuration (file size limits, allowed extensions, compression, encryption, antivirus) |
|
||||
| `file_operations` | get, create, update, delete, list, download - with actual file download implementation |
|
||||
| `get_file_url` | Generate download, preview, or view URLs with transformations |
|
||||
|
||||
</details>
|
||||
@@ -246,17 +245,6 @@ Once integrated, you should be able to use commands like:
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>📧 Messaging Operations (3 tools)</strong></summary>
|
||||
|
||||
| Tool | Actions | Description |
|
||||
|------|---------|-------------|
|
||||
| `messaging_message_operations` | create, get, list, update, delete | Complete message management |
|
||||
| `messaging_topic_operations` | create, get, list, update, delete | Complete topic management |
|
||||
| `messaging_subscriber_operations` | create, get, list, delete | Complete subscriber management |
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>🏥 Health Monitoring (1 tool)</strong></summary>
|
||||
|
||||
@@ -278,21 +266,21 @@ Once integrated, you should be able to use commands like:
|
||||
- **Appwrite Cloud**: `https://cloud.appwrite.io/v1`
|
||||
- **Self-hosted**: `https://your-domain.com/v1`
|
||||
3. **🔐 API Key**: Create a new API key in your Appwrite console under **Settings > API Keys**
|
||||
- ✅ Required scopes: `databases.read`, `databases.write`, `users.read`, `users.write`, `storage.read`, `storage.write`, `messages.read`, `messages.write`, `topics.read`, `topics.write`, `subscribers.read`, `subscribers.write`, `teams.read`, `teams.write`, `health.read`
|
||||
- ✅ Required scopes: `databases.read`, `databases.write`, `users.read`, `users.write`, `storage.read`, `storage.write`, `teams.read`, `teams.write`, `health.read`
|
||||
|
||||
### 🎯 VS Official Implementation
|
||||
|
||||
| Feature | Our Implementation | Official Appwrite MCP |
|
||||
|---------|-------------------|----------------------|
|
||||
| **Tools Available** | 🟢 16 optimized tools (context-efficient) | 🟡 195 tools (selective enabling) |
|
||||
| **Context Usage** | 🟢 Under 25,000 tokens (88% reduction) | 🔴 Over 60,000 tokens |
|
||||
| **Tools Available** | 🟢 12 optimized tools (context-efficient) | 🟡 195 tools (selective enabling) |
|
||||
| **Context Usage** | 🟢 Optimized token usage | 🔴 Over 60,000 tokens |
|
||||
| **Tool Design** | 🟢 Action-based combined tools | 🟡 Individual tools for each operation |
|
||||
| **Core Operations** | 🟢 All essential Appwrite features | 🟡 Database tools only (context limits) |
|
||||
| **Messaging Service** | 🟢 Messages, topics, subscribers | 🟡 Selective enabling required |
|
||||
| **Storage Operations** | 🟢 Complete file operations & uploads | 🟡 Basic bucket operations |
|
||||
| **Core Operations** | 🟢 All essential database, user, storage, and team features | 🟡 Database tools only (context limits) |
|
||||
| **Storage Operations** | 🟢 Complete file operations with download & advanced bucket config | 🟡 Basic bucket operations |
|
||||
| **User Management** | 🟢 CRUD + preferences + bulk operations | 🟡 Basic CRUD only |
|
||||
| **Advanced Features** | 🟢 Document security, file encryption, array attributes, compression | 🔴 Limited |
|
||||
| **Bulk Operations** | 🟢 Integrated into respective categories | 🔴 Not available |
|
||||
| **Error Handling** | 🟢 Comprehensive | 🟡 Basic |
|
||||
| **Error Handling** | 🟢 Comprehensive with validation | 🟡 Basic |
|
||||
| **Language** | 🟡 TypeScript/Node.js | 🟢 Python |
|
||||
| **Maintenance** | 🟢 Easier with fewer tools | 🟡 Complex with many tools |
|
||||
|
||||
@@ -372,18 +360,6 @@ Once integrated, you can use natural language commands with Claude to interact w
|
||||
|
||||
|
||||
|
||||
<details>
|
||||
<summary><strong>📧 Messaging & Communication</strong></summary>
|
||||
|
||||
```
|
||||
✨ "List all messaging topics"
|
||||
✨ "Create a topic for user announcements"
|
||||
✨ "Add subscribers to the announcements topic"
|
||||
✨ "Send a message to all subscribers"
|
||||
✨ "List all messages and their delivery status"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user