Add Docker Compose and Continue VS Code extension deployment documentation

[Copilot]

Documentation Enhancement Plan

• Review the current README structure and Docker documentation
• Add a new "Docker Deployment" section after the "Running the MCP Server" section
• Include the Docker Compose configuration provided by the user
• Add Continue VS Code extension configuration example
• Add explanatory notes about SSE mode and environment variables
• Ensure proper formatting and consistency with existing documentation
• Create a changeset for the documentation update
• Address code review feedback - clarify file path notation
• Fix registry name (GitHub Container Registry, not Docker Hub)
• Clarify file location as workspace root
• Wrap Docker deployment section in expandable <details> block
• Remove excessive comments from YAML configurations
• Validate the changes

All tasks completed successfully!

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Just sharing docker compose, continue vscode extension config that worked with this.</issue_title>
<issue_description>Hello,

Works well,

I use the Continue vscode extension

configuration in:

[workspace]/.continue/mcpServers/paperless-mcp.yaml

name: Paperless
version: 0.0.1
schema: v1
mcpServers:
  - name: Paperless
    # Use the 'sse' type for remote HTTP connections
    type: sse 
    
    # Specify the URL of the running Docker container's SSE endpoint
    # This assumes you mapped container port 3001 to host port 3001
    url: http://your-docker-compose-server:3000/sse
    
    # Credentials are NOT needed here, as they are already injected 
    # as environment variables into the Docker container.

Docker Compose File, wherever you host your docker compose files. Obviously, you'll want to use a more protected .env if you care or for serious production but most self hosters won't need to care about it.

services:
  paperless-mcp:
    # Use a descriptive name for the container
    container_name: paperless-mcp
    
    # Specify the image from your configuration
    image: ghcr.io/baruchiro/paperless-mcp:latest
        
    # `PAPERLESS_URL` and `PAPERLESS_API_KEY` are necessary for the MCP tool 
    # to communicate with your main Paperless-ngx instance.
    environment:
      - PAPERLESS_URL=http://yourpaperless-ngx-server:8000
      - PAPERLESS_API_KEY=YOUR-PAPERLESS-API-KEY
      - PAPERLESS_PUBLIC_URL=https://paperless-ngx.yourpublicurl.com
# Map internal port 3000 to external port 3000
    ports:
      - "3000:3000"      
    # `--rm` (remove container upon exit) is a `docker run` flag.
    # In Compose, this is achieved with `restart: "no"`. 
    # Since this is a utility/script (MCP) that runs a task and exits, 
    # 'no' is appropriate, or 'always' if you want it to continually retry/run.
    # you can omit 'restart' entirely.
    restart: "no"

Thanks!</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes Just sharing docker compose, continue vscode extension config that worked with this. #28

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

---

Note

Adds deployment and editor-integration docs for easier setup.

• README: New expandable "Docker Deployment" section with a docker-compose.yml example (port 3000, required env vars) and notes on SSE and auth via environment variables
• Continue VS Code: Example .continue/mcpServers/paperless-mcp.yaml using type: sse pointing to http://localhost:3000/sse
• Changeset: Patch release entry documenting the docs update

^{Written by Cursor Bugbot for commit 6e48f3a. This will update automatically on new commits. Configure here.}

[changeset-bot]

🦋 Changeset detected

Latest commit: 17daf4e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@baruchiro/paperless-mcp	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

• 🔍 Trigger a full review

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[baruchiro]

I don't want the README to be too long, please insert the variants of many installations methods into expand blocks

[baruchiro]

To keep the documentation easy to read, I want you to hide these sections under detailes element.

[Copilot]

Implemented in commit 6e48f3a. The Docker Deployment section is now hidden under a <details> element with "Docker Deployment" as the summary text.

[Copilot]

I don't want the README to be too long, please insert the variants of many installations methods into expand blocks

Done in commit 6e48f3a. The Docker Deployment section is now wrapped in an expandable <details> block to keep the README concise.

[Copilot]

Pull request overview

This PR adds comprehensive Docker deployment documentation to help users run the Paperless-NGX MCP server in containerized environments, particularly with the Continue VS Code extension.

Changes:

• Added Docker Compose configuration example with required environment variables
• Added Continue VS Code extension configuration for connecting to the Dockerized MCP server via SSE
• Created changeset for patch version bump

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
README.md	Adds new "Docker Deployment" section with Docker Compose and Continue VS Code extension configuration examples, placed in a collapsible <details> block after the "Running the MCP Server" section
.changeset/bright-wolves-worry.md	Adds changeset for patch version bump with documentation update description