Nextcloud MCP Server

Enable AI assistants to interact with your Nextcloud instance.

The Nextcloud MCP (Model Context Protocol) server allows 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.

High-level Comparison: Nextcloud MCP Server vs. Nextcloud AI Stack

See our detailed comparison for architecture diagrams, workflow examples, and guidance on when to use each approach.

Want to see another Nextcloud app supported? Open an issue or contribute a pull request!

Authentication

OAuth2/OIDC provides secure, per-user authentication with access tokens. See Authentication Guide for details.

Quick Start

1. Install

# Clone the repository
git clone https://github.com/cbcoutinho/nextcloud-mcp-server.git
cd nextcloud-mcp-server

# Install with uv (recommended)
uv sync

# Or using Docker
docker pull ghcr.io/cbcoutinho/nextcloud-mcp-server:latest

# Or deploy to Kubernetes with Helm
helm repo add nextcloud-mcp https://cbcoutinho.github.io/nextcloud-mcp-server
helm repo update
helm install nextcloud-mcp nextcloud-mcp/nextcloud-mcp-server \
  --set nextcloud.host=https://cloud.example.com \
  --set auth.basic.username=myuser \
  --set auth.basic.password=mypassword

See Installation Guide for detailed instructions, or Helm Chart README for Kubernetes deployment.

2. Configure

Create a .env file:

# Copy the sample
cp env.sample .env

For Basic Auth (recommended for most users):

NEXTCLOUD_HOST=https://your.nextcloud.instance.com
NEXTCLOUD_USERNAME=your_username
NEXTCLOUD_PASSWORD=your_app_password

For OAuth (experimental - requires patches):

NEXTCLOUD_HOST=https://your.nextcloud.instance.com

See Configuration Guide for all options.

3. Set Up Authentication

Basic Auth Setup (recommended):

1. Create an app password in Nextcloud (Settings → Security → Devices & sessions)

2. Add credentials to .env file

3. Start the server

OAuth Setup (experimental):

1. Install Nextcloud OIDC apps (oidc v1.10.0+ + user_oidc)

2. Apply required patch to user_oidc app for Bearer token support (see OAuth Upstream Status)

3. Enable dynamic client registration or create an OIDC client with id & secret

4. Configure Bearer token validation in user_oidc

5. Start the server

See OAuth Quick Start for 5-minute setup or OAuth Setup Guide for detailed instructions.

4. Run the Server

# Load environment variables
export $(grep -v '^#' .env | xargs)

# Start with Basic Auth (default)
uv run nextcloud-mcp-server

# Or start with OAuth (experimental - requires patches)
uv run nextcloud-mcp-server --oauth

# Or with Docker
docker run -p 127.0.0.1:8000:8000 --env-file .env --rm \
  ghcr.io/cbcoutinho/nextcloud-mcp-server:latest

The server starts on http://127.0.0.1:8000 by default.

See Running the Server for more options.

5. Connect an MCP Client

Test with MCP Inspector:

uv run mcp dev

Or connect from:

• Claude Desktop

• Any MCP-compatible client

Documentation

Getting Started

• Installation - Install the server

• Configuration - Environment variables and settings

• Authentication - OAuth vs BasicAuth

• Running the Server - Start and manage the server

Architecture

• Comparison with Context Agent - How this MCP server differs from Nextcloud's Context Agent

OAuth Documentation (Experimental)

• OAuth Quick Start - 5-minute setup guide

• OAuth Setup Guide - Detailed setup instructions

• OAuth Architecture - How OAuth works

• OAuth Troubleshooting - OAuth-specific issues

• Upstream Status - Required patches and PRs ⚠️

Reference

• Troubleshooting - Common issues and solutions

App-Specific Documentation

• Notes API

• Calendar (CalDAV)

• Contacts (CardDAV)

• Cookbook

• Deck

• Tables

• WebDAV

MCP Tools & Resources

The server exposes Nextcloud functionality through MCP tools (for actions) and resources (for data browsing).

Tools

The server provides 90+ tools across 8 Nextcloud apps. When using OAuth, tools are dynamically filtered based on your granted scopes.

For a complete list of all supported OAuth scopes and their descriptions, see OAuth Scopes Documentation.

Available Tool Categories

Document Processing (Optional)

The WebDAV file reading tool (nc_webdav_read_file) supports automatic text extraction from documents and images:

Supported Formats:

• Documents: PDF, DOCX, PPTX, XLSX, RTF, ODT, EPUB

• Images: PNG, JPEG, TIFF, BMP (with OCR)

• Email: EML, MSG files

Features:

• Progress Notifications: Long-running OCR operations (up to 120s) send progress updates every 10 seconds to prevent client timeouts

• Pluggable Architecture: Multiple processor backends (Unstructured.io, Tesseract, custom HTTP APIs)

• Automatic Detection: Files are processed based on MIME type

• Graceful Fallback: Returns base64-encoded content if processing fails

Configuration:

# Enable document processing (optional)
ENABLE_DOCUMENT_PROCESSING=true

# Unstructured.io processor (cloud/API-based, supports many formats)
ENABLE_UNSTRUCTURED=true
UNSTRUCTURED_API_URL=http://localhost:8002
UNSTRUCTURED_STRATEGY=auto  # auto, fast, or hi_res
UNSTRUCTURED_LANGUAGES=eng,deu
PROGRESS_INTERVAL=10  # Progress update interval in seconds

# Tesseract processor (local OCR, images only)
ENABLE_TESSERACT=false
TESSERACT_LANG=eng

# Custom HTTP processor
ENABLE_CUSTOM_PROCESSOR=false
CUSTOM_PROCESSOR_URL=http://localhost:9000/process
CUSTOM_PROCESSOR_TYPES=application/pdf,image/jpeg

Example Usage:

AI: "Read the contents of Documents/report.pdf"
→ Uses nc_webdav_read_file tool with automatic OCR processing
→ Returns extracted text with parsing metadata
→ Sends progress updates during long operations

See env.sample for complete configuration options.

Example Tools:

• nc_notes_create_note - Create a new note

• nc_cookbook_import_recipe - Import recipes from URLs with schema.org metadata

• deck_create_card - Create a Deck card

• nc_calendar_create_event - Create a calendar event

• nc_calendar_create_todo - Create a CalDAV task/todo

• nc_contacts_create_contact - Create a contact

• nc_webdav_upload_file - Upload a file to Nextcloud

• And 80+ more...

Resources

Resources provide read-only access to Nextcloud data:

• nc://capabilities - Server capabilities

• cookbook://version - Cookbook app version info

• nc://Deck/boards/{board_id} - Deck board data

• notes://settings - Notes app settings

• And more...

Run uv run nextcloud-mcp-server --help to see all available options.

Examples

Create a Note

AI: "Create a note called 'Meeting Notes' with today's agenda"
→ Uses nc_notes_create_note tool

Manage Recipes

AI: "Import the recipe from this URL: https://www.example.com/recipe/chocolate-cake"
→ Uses nc_cookbook_import_recipe tool to extract schema.org metadata

Manage Calendar

AI: "Schedule a team meeting for next Tuesday at 2pm"
→ Uses nc_calendar_create_event tool

Organize Files

AI: "Create a folder called 'Project X' and move all PDFs there"
→ Uses WebDAV tools (nc_webdav_create_directory, nc_webdav_move)

Project Management

AI: "Create a new Deck board for Q1 planning with Todo, In Progress, and Done stacks"
→ Uses deck_create_board and deck_create_stack tools

Transport Protocols

The server supports multiple MCP transport protocols:

• streamable-http (recommended) - Modern streaming protocol

• sse (default, deprecated) - Server-Sent Events for backward compatibility

• http - Standard HTTP protocol

# Use streamable-http (recommended)
uv run nextcloud-mcp-server --transport streamable-http

Contributing

Contributions are welcome!

• Report bugs or request features: GitHub Issues

• Submit improvements: Pull Requests

• Read CLAUDE.md for development guidelines

Security

This project takes security seriously:

• OAuth2/OIDC support (experimental - requires upstream patches)

• Basic Auth with app-specific passwords (recommended)

• No credential storage with OAuth mode

• Per-user access tokens

• Regular security assessments

Found a security issue? Please report it privately to the maintainers.

License

This project is licensed under the AGPL-3.0 License. See LICENSE for details.

Star History

References

• Model Context Protocol

• MCP Python SDK

• Nextcloud