🎩 You're Invited:Meet the Socket team at Black Hat in Las Vegas, August 3-6.RSVP
Sign In

dicomweb-mcp-server

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

dicomweb-mcp-server

DICOMweb Model Context Protocol (MCP) server implementation

latest
Source
npmnpm
Version
0.0.4
Version published
Maintainers
1
Created
Source

NPM version NPM downloads build MIT License dicomweb-mcp-server MCP server

dicomweb-mcp-server

A Model Context Protocol (MCP) server that exposes a DICOMweb-compliant DICOM archive to AI assistants. It lets any MCP-capable client search studies, series and instances, inspect metadata, read Structured and Encapsulated PDF Reports, and render image frames — all through natural language.

Requirements

  • Node.js 20 or later
  • A running DICOMweb server supporting QIDO-RS and WADO-RS (e.g. orthanc)

The following endpoints must be supported by the DICOMweb server:

EndpointServiceUsed by
GET /studiesQIDO-RSSearch studies
GET /studies/{study}/seriesQIDO-RSSearch series
GET /studies/{study}/series/{series}/instancesQIDO-RSSearch instances, search structured reports, search encapsulated PDF reports
GET /studies/{study}/series/{series}/instances/{instance}/metadataWADO-RSGet instance metadata, get structured report text, get encapsulated PDF report text
GET /studies/{study}/series/{series}/instances/{instance}/frames/{frame}/renderedWADO-RSRender instance frame

Installation

npx dicomweb-mcp-server

The server reads its configuration from a .env file located in the same directory as the script (see Configuration below).

Global install

npm install -g dicomweb-mcp-server
dicomweb-mcp-server

Configuration

Create a .env file with the connection details for your DICOMweb server. Place the file next to wherever the server is executed from (or in the working directory you configure in your MCP client).

# Required
DICOMWEB_HOST=https://your-dicomweb-server/dicomweb

# Optional — authentication
DICOMWEB_AUTH=basic        # basic | bearer
DICOMWEB_USER=username     # required when DICOMWEB_AUTH=basic
DICOMWEB_PASS=password     # required when DICOMWEB_AUTH=basic
DICOMWEB_TOKEN=your-token  # required when DICOMWEB_AUTH=bearer

# Optional — request timeout (milliseconds)
DICOMWEB_TIMEOUT=30000
VariableRequiredDescription
DICOMWEB_HOSTYesBase URL of the DICOMweb server (used for both QIDO-RS and WADO-RS requests)
DICOMWEB_AUTHNoAuthentication type: basic or bearer
DICOMWEB_USERConditionalUsername — required when DICOMWEB_AUTH=basic
DICOMWEB_PASSConditionalPassword — required when DICOMWEB_AUTH=basic
DICOMWEB_TOKENConditionalBearer token — required when DICOMWEB_AUTH=bearer
DICOMWEB_TIMEOUTNoFetch timeout in milliseconds. Omit to disable.

MCP Client Setup

Claude Desktop

Add the server to claude_desktop_config.json:

{
  "mcpServers": {
    "dicomweb": {
      "command": "npx",
      "args": ["-y", "dicomweb-mcp-server"],
      "env": {
        "DICOMWEB_HOST": "https://your-dicomweb-server/dicomweb"
      }
    }
  }
}

You can supply all environment variables directly in the env block instead of using a .env file.

VS Code (GitHub Copilot Agent Mode)

Add to your VS Code settings.json or workspace .vscode/mcp.json:

{
  "servers": {
    "dicomweb": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "dicomweb-mcp-server"],
      "env": {
        "DICOMWEB_HOST": "https://your-dicomweb-server/dicomweb"
      }
    }
  }
}

Cursor

Add to .cursor/mcp.json in your project root, or to the global ~/.cursor/mcp.json:

{
  "mcpServers": {
    "dicomweb": {
      "command": "npx",
      "args": ["-y", "dicomweb-mcp-server"],
      "env": {
        "DICOMWEB_HOST": "https://your-dicomweb-server/dicomweb"
      }
    }
  }
}

Available Tools

find-studies

Searches DICOM studies on the configured DICOMweb server. Results are sorted by study date, newest first.

ParameterTypeDescription
querystringSpace-separated key=value filter string (see Query Syntax). Pass "" to return all studies.

Example prompts

  • "Find all CT studies for patient John Doe"
  • "Search for studies from January 2024"

find-series

Searches DICOM series within a single study. Results are sorted by series date, newest first.

ParameterTypeDescription
studyInstanceUidstringStudy Instance UID — obtain from find-studies
querystringSpace-separated key=value filter string. Pass "" to return all series.

find-instances

Searches DICOM instances within a single series. Results are sorted by Instance Number ascending.

ParameterTypeDescription
studyInstanceUidstringStudy Instance UID — obtain from find-studies
seriesInstanceUidstringSeries Instance UID — obtain from find-series
querystringSpace-separated key=value filter string. Pass "" to return all instances.

find-encapsulated-pdf-reports

Finds all Encapsulated PDF instances in a study by looking for DOC-modality series and filtering by the Encapsulated PDF SOP Class UID (1.2.840.10008.5.1.4.1.1.104.1).

ParameterTypeDescription
studyInstanceUidstringStudy Instance UID — obtain from find-studies

Example prompts

  • "Find all PDF reports in study 1.2.3.4"
  • "Are there any encapsulated PDF documents in this study?"

get-encapsulated-pdf-report-text

Retrieves an Encapsulated PDF DICOM instance and extracts its text content.

ParameterTypeDescription
studyInstanceUidstringStudy Instance UID
seriesInstanceUidstringSeries Instance UID
sopInstanceUidstringSOP Instance UID — obtain from find-encapsulated-pdf-reports

Note: Text extraction only works for searchable (text-based) PDFs. PDFs that consist entirely of scanned page images without an embedded text layer will yield little or no text. In those cases, no OCR is performed.

Example prompts

  • "Read the PDF report for SOP instance 1.2.3.4.5"
  • "What does the encapsulated PDF document say?"

find-structured-reports

Finds all Structured Report (SR) instances in a study by looking for SR-modality series and filtering by known SR SOP Class UIDs.

ParameterTypeDescription
studyInstanceUidstringStudy Instance UID — obtain from find-studies

get-structured-report-text

Retrieves a Structured Report instance and converts it to human-readable text.

ParameterTypeDescription
studyInstanceUidstringStudy Instance UID
seriesInstanceUidstringSeries Instance UID
sopInstanceUidstringSOP Instance UID — obtain from find-structured-reports

get-instance-metadata

Retrieves and formats all DICOM attributes of a single instance as human-readable text. Does not retrieve pixel data.

ParameterTypeDescription
studyInstanceUidstringStudy Instance UID
seriesInstanceUidstringSeries Instance UID
sopInstanceUidstringSOP Instance UID — obtain from find-instances

render-instance-frame

Renders a specific frame from a DICOM instance and returns it as an inline image (JPEG or PNG).

ParameterTypeDescription
studyInstanceUidstringStudy Instance UID
seriesInstanceUidstringSeries Instance UID
sopInstanceUidstringSOP Instance UID — obtain from find-instances
frameinteger1-based frame index (use 1 for single-frame instances)
outputFormatenumimage/jpeg or image/png

Example prompt

  • "Show me the first frame of SOP instance 1.2.3.4.5 as a JPEG"

Query Syntax

The query parameter accepted by the search tools is a space-separated list of key=value pairs.

Key formats

FormatExample
DICOM keyword namePatientName=DOE*
8-digit hex tag00100020=12345

Special keys

KeyDescription
limit=NMaximum number of results to return
offset=NSkip the first N results (for pagination)
fuzzymatching=trueEnable fuzzy (phonetic) name matching
includefield=allRequest all available DICOM attributes

Examples

PatientName=DOE*
StudyDate=20240101-20241231 ModalitiesInStudy=CT
00100020=ABC123 limit=10
fuzzymatching=true PatientName=Smith

Wildcard * is supported in string values where the DICOMweb server allows it.

Typical Workflow

A natural conversational sequence with the MCP server looks like this:

  • Search studiesfind-studies with a patient name or date range.
  • Browse seriesfind-series with the Study Instance UID returned in step 1.
  • List instancesfind-instances with Study and Series UIDs from steps 1–2.
  • Inspect or renderget-instance-metadata for DICOM attributes, or render-instance-frame to view pixel data.
  • Read SR reportsfind-structured-reports then get-structured-report-text for SR documents.
  • Read PDF reportsfind-encapsulated-pdf-reports then get-encapsulated-pdf-report-text for Encapsulated PDF documents.

License

dicomweb-mcp-server is released under the MIT License.

dicomweb-mcp-server MCP server

Keywords

DICOM

FAQs

Package last updated on 16 May 2026

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts