Chris CoutinhoandClaude Opus 4.7
367816e4e4
Address four small items from the latest PR #743 review: - login-flow-v2.md Compose example: add an inline comment + follow-up note pointing readers at Docker secrets for TOKEN_ENCRYPTION_KEY (the snippet is likely to be copy-pasted into production). - auth-flows.md: rename the third column in the Astrolabe → MCP Server diagram from "Nextcloud OIDC" to "OIDC Provider" so the diagram matches the multi-IdP framing in the surrounding prose. - login-flow-v2.md OAuth Endpoints section: rewrite the ambiguous "token issuance still comes from the IdP" line to make the cryptographic separation explicit — the MCP server exposes /token, but tokens are signed by the IdP's key and validated against its JWKS; the MCP server has no signing keys of its own. - README.md auth bullet: replace the jargony "OAuth-to-MCP supported, with app-password conversion to Nextcloud" with the reviewer's clearer wording: "MCP clients authenticate via OAuth, the server handles Nextcloud app passwords transparently". Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
157 lines
8.6 KiB
Markdown
157 lines
8.6 KiB
Markdown
<p align="center">
|
|
<img src="astrolabe.svg" alt="Nextcloud MCP Server" width="128" height="128">
|
|
</p>
|
|
|
|
# Nextcloud MCP Server
|
|
|
|
[](https://github.com/cbcoutinho/nextcloud-mcp-server/pkgs/container/nextcloud-mcp-server)
|
|
|
|
**A production-ready MCP server that connects AI assistants to your Nextcloud instance.**
|
|
|
|
Enable Large Language Models like Claude, GPT, and Gemini to interact with your Nextcloud data through a secure API. Create notes, manage calendars, organize contacts, work with files, and more - all through natural language conversations.
|
|
|
|
This is a **dedicated standalone MCP server** designed for external MCP clients like Claude Code and IDEs. It runs independently of Nextcloud (Docker, VM, Kubernetes, or local) and provides deep CRUD operations across Nextcloud apps.
|
|
|
|
> [!NOTE]
|
|
> **Looking for AI features inside Nextcloud?** Nextcloud also provides [Context Agent](https://github.com/nextcloud/context_agent), which powers the Assistant app and runs as an ExApp inside Nextcloud. See [docs/comparison-context-agent.md](docs/comparison-context-agent.md) for a detailed comparison of use cases.
|
|
|
|
> [!TIP]
|
|
> **Don't want to self-host?** [Astrolabe Cloud](https://astrolabecloud.com) is a managed hosting service for this MCP server, aimed at users and teams who want advanced features like background sync and semantic search without operating the infrastructure themselves. The service is currently under development — sign up on the landing page to join the early-adopter list.
|
|
|
|
## Quick Start
|
|
|
|
Run the server locally with [uvx](https://docs.astral.sh/uv/) (no installation required):
|
|
|
|
```bash
|
|
NEXTCLOUD_HOST=https://your.nextcloud.instance.com \
|
|
NEXTCLOUD_USERNAME=your_username \
|
|
NEXTCLOUD_PASSWORD=your_app_password \
|
|
uvx nextcloud-mcp-server run --transport stdio
|
|
```
|
|
|
|
Or add it directly to your MCP client configuration (e.g. `claude_desktop_config.json` or `.claude/settings.json`):
|
|
|
|
```json
|
|
{
|
|
"mcpServers": {
|
|
"nextcloud": {
|
|
"command": "uvx",
|
|
"args": ["nextcloud-mcp-server", "run", "--transport", "stdio"],
|
|
"env": {
|
|
"NEXTCLOUD_HOST": "https://your.nextcloud.instance.com",
|
|
"NEXTCLOUD_USERNAME": "your_username",
|
|
"NEXTCLOUD_PASSWORD": "your_app_password"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
> [!TIP]
|
|
> Generate an [app password](https://docs.nextcloud.com/server/latest/user_manual/en/session_management.html#managing-devices) in Nextcloud under **Settings > Security > Devices & sessions** instead of using your login password.
|
|
|
|
### Docker
|
|
|
|
For full features including semantic search, run with Docker:
|
|
|
|
```bash
|
|
docker run -p 127.0.0.1:8000:8000 --rm \
|
|
-e NEXTCLOUD_HOST=https://your.nextcloud.instance.com \
|
|
-e NEXTCLOUD_USERNAME=your_username \
|
|
-e NEXTCLOUD_PASSWORD=your_app_password \
|
|
ghcr.io/cbcoutinho/nextcloud-mcp-server:latest
|
|
```
|
|
|
|
Then connect your MCP client (Claude Desktop, IDEs, `mcp dev`, etc.) to `http://127.0.0.1:8000/mcp`.
|
|
|
|
For Kubernetes, see [cbcoutinho/helm-charts](https://github.com/cbcoutinho/helm-charts). For other deployment options and Compose profiles, see [docs/installation.md](docs/installation.md).
|
|
|
|
## Key Features
|
|
|
|
- **110+ MCP Tools** - Comprehensive API coverage across 10 Nextcloud apps
|
|
- **MCP Resources** - Structured data URIs for browsing Nextcloud data
|
|
- **Semantic Search (Experimental)** - Optional vector-powered search for Notes, Files, News items, and Deck cards (requires Qdrant + Ollama)
|
|
- **Document Processing** - OCR and text extraction from PDFs, DOCX, images with progress notifications
|
|
- **Flexible Deployment** - Docker, Kubernetes ([Helm chart](https://github.com/cbcoutinho/helm-charts)), VM, or local installation
|
|
- **Production-Ready Auth** - Basic Auth with app passwords; multi-user via Login Flow v2 — MCP clients authenticate via OAuth, the server handles Nextcloud app passwords transparently
|
|
- **Multiple Transports** - streamable-http (default) and stdio
|
|
|
|
## Supported Apps
|
|
|
|
| App | Tools | Capabilities |
|
|
|-----|-------|--------------|
|
|
| **Notes** | 7 | Full CRUD, keyword search, semantic search |
|
|
| **Calendar** | 20+ | Events, todos (tasks), recurring events, attendees, availability |
|
|
| **Contacts** | 8 | Full CardDAV support, address books |
|
|
| **Files (WebDAV)** | 12 | Filesystem access, OCR/document processing |
|
|
| **Deck** | 15 | Boards, stacks, cards, labels, assignments |
|
|
| **Cookbook** | 13 | Recipe management, URL import (schema.org) |
|
|
| **Tables** | 5 | Row operations on Nextcloud Tables |
|
|
| **Sharing** | 10+ | Create and manage shares |
|
|
| **News** | 8 | Feeds, folders, items, feed health monitoring |
|
|
| **Collectives** | 16 | Full CRUD on collectives, pages, and tags |
|
|
| **Talk (spreed)** | 6 | List conversations, read/post messages, mark as read, list participants |
|
|
| **Semantic Search** | 2+ | Vector search for Notes, Files, News items, and Deck cards (experimental, opt-in, requires infrastructure) |
|
|
|
|
Want to see another Nextcloud app supported? [Open an issue](https://github.com/cbcoutinho/nextcloud-mcp-server/issues) or contribute a pull request!
|
|
|
|
## Authentication
|
|
|
|
The MCP server authenticates to Nextcloud using **app-specific passwords** (Basic Auth). Three deployment modes are supported:
|
|
|
|
| Mode | Best for |
|
|
|------|----------|
|
|
| Single-User (BasicAuth) | Personal use, development, single-user deployments |
|
|
| Multi-User (BasicAuth pass-through) | Multi-user setups where clients send credentials via Authorization header |
|
|
| Multi-User (Login Flow v2) | Multi-user / hosted deployments — clients authenticate to the MCP server via OAuth, and the server obtains a per-user app password from Nextcloud and uses it transparently |
|
|
|
|
OAuth-direct-to-Nextcloud is no longer supported (it required upstream patches to `user_oidc` that were never merged). Login Flow v2 replaces it for multi-user deployments and works with stock Nextcloud.
|
|
|
|
See [docs/authentication.md](docs/authentication.md) for setup instructions.
|
|
|
|
## Semantic Search
|
|
|
|
An experimental RAG pipeline that lets MCP clients find Nextcloud content by **meaning** rather than keywords — a query for "car" also surfaces notes about "vehicle" or "transportation". Disabled by default (`ENABLE_SEMANTIC_SEARCH=false`); requires a vector database and embedding service. See [docs/semantic-search-architecture.md](docs/semantic-search-architecture.md) and [docs/configuration.md](docs/configuration.md).
|
|
|
|
> [!TIP]
|
|
> **Don't want to run Qdrant and an embedding service?** [Astrolabe Cloud](https://astrolabecloud.com) (under development) provides semantic search and background sync as a managed service.
|
|
|
|
## Documentation
|
|
|
|
- **[Installation](docs/installation.md)** — Docker, Compose profiles, local, VM
|
|
- **[Configuration](docs/configuration.md)** — Environment variables, document processing, semantic search setup
|
|
- **[Authentication](docs/authentication.md)** — Basic Auth, Login Flow v2
|
|
- **[Running the Server](docs/running.md)** — Start, manage, troubleshoot
|
|
- **[App Documentation](docs/)** — Per-app guides (Notes, Calendar, Contacts, WebDAV, Deck, Cookbook, Tables)
|
|
- **[Semantic Search Architecture](docs/semantic-search-architecture.md)** + **[Vector Sync UI](docs/user-guide/vector-sync-ui.md)**
|
|
- **[Login Flow v2](docs/login-flow-v2.md)** — recommended multi-user setup (architecture, env vars, scope reference, troubleshooting)
|
|
- **[Troubleshooting](docs/troubleshooting.md)** · **[Comparison with Context Agent](docs/comparison-context-agent.md)**
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome!
|
|
|
|
- Report bugs or request features: [GitHub Issues](https://github.com/cbcoutinho/nextcloud-mcp-server/issues)
|
|
- Submit improvements: [Pull Requests](https://github.com/cbcoutinho/nextcloud-mcp-server/pulls)
|
|
- Development guidelines: [CLAUDE.md](CLAUDE.md)
|
|
|
|
## Security
|
|
|
|
[](https://mseep.ai/app/cbcoutinho-nextcloud-mcp-server)
|
|
|
|
Found a security issue? **Do not open a public GitHub issue.** Use GitHub's [private vulnerability reporting](https://github.com/cbcoutinho/nextcloud-mcp-server/security/advisories/new), or email **security@astrolabecloud.com** if you can't use GitHub. See [SECURITY.md](./SECURITY.md) for details.
|
|
|
|
## License
|
|
|
|
This project is licensed under the AGPL-3.0 License. See [LICENSE](./LICENSE) for details.
|
|
|
|
## Star History
|
|
|
|
[](https://www.star-history.com/#cbcoutinho/nextcloud-mcp-server&Date)
|
|
|
|
## References
|
|
|
|
- [Model Context Protocol](https://github.com/modelcontextprotocol)
|
|
- [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk)
|
|
- [Nextcloud](https://nextcloud.com/)
|