How do I install Mainframe?

Copy the stdio config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.

Does Mainframe need an API key?

The publisher lists these environment variables: ZOSMF_HOST, ZOSMF_PORT, ZOSMF_BASE_PATH, ZOSMF_USER, ZOSMF_PASSWORD, ZOSMF_TOKEN, ZOSMF_TOKEN_TYPE, ZOSMF_REJECT_UNAUTHORIZED, ZOSMF_CERT, ZOSMF_CERT_KEY, ZOSMF_TOKEN_FILE, ZOSMF_USER_ID, ZOSMF_PASSTICKET_APP, ZOWE_TEAM_CONFIG, ZOSMF_PROFILE, LOG_LEVEL, MCP_TRANSPORT, MCP_SSE_PORT, MAX_JOB_OUTPUT_LINES, MAX_DATASET_READ_LINES, MAX_JES_SPOOL_FILES, MAX_AUDIT_LINES, CMCI_CONTEXT, CMCI_HOST, CMCI_PORT, CMCI_BASE_PATH, DB2_LOCATION, DB2_HOST, DB2_PORT, DB2_BASE_PATH, SMF_SUMMARY_DATASET, RMF_METRICS_ENABLED, RACF_AUDIT_USS_PATH, RACF_AUDIT_DATASET, SECURITY_READ_ONLY, SECURITY_ALLOWED_TOOLS, SECURITY_BLOCKED_TOOLS, SECURITY_ALLOWED_DATASET_PATTERNS, SECURITY_ALLOWED_USS_PATHS, SECURITY_AUDIT_LOGGING, SECURITY_MAX_JCL_BYTES, SECURITY_WRITE_APPROVAL, SECURITY_JCL_SCAN, SECURITY_JCL_SCAN_STRICT, SECURITY_BLOCKED_PROGRAMS, SECURITY_BLOCKED_JOB_CLASSES, SECURITY_CHANGE_TICKET_PATTERN, SECURITY_WRITE_WINDOW, SECURITY_WRITE_DAYS, SECURITY_WRITE_WINDOW_TZ.

What transport does Mainframe use?

Mainframe runs locally over stdio.

When was Mainframe last checked?

Last checked 2026-11-09. MCP server for IBM z/OS jobs, datasets, USS, and operational diagnostics via Zowe SDK.

Mainframe MCP server

Power your agent

Add this server

The publisher's own command. Not a PlugMCP endpoint.

Add to Cursor Add to VS Code Run on PlugMCP

Host a copy with our keys and logs.

Local command

npx -y @notharshhaa/[email protected]

Credentials from the publisher

ZOSMF_HOST — z/OSMF hostname or IP address
ZOSMF_PORT — z/OSMF HTTPS port (default 443)
ZOSMF_BASE_PATH — Optional API gateway or mediation layer prefix for z/OSMF
ZOSMF_USER — z/OS user id (required with ZOSMF_PASSWORD unless ZOSMF_TOKEN is set)
ZOSMF_PASSWORD — Password for basic auth (required with ZOSMF_USER unless ZOSMF_TOKEN is set)
ZOSMF_TOKEN — Auth token (alternative to user/password)
ZOSMF_TOKEN_TYPE — Token type when using ZOSMF_TOKEN (e.g. LTPA2)
ZOSMF_REJECT_UNAUTHORIZED — Verify TLS certificates (true in production)
ZOSMF_CERT — PEM client certificate file path for mTLS auth
ZOSMF_CERT_KEY — PEM client key file path for mTLS auth (required with ZOSMF_CERT)
ZOSMF_TOKEN_FILE — Read ZOSMF_TOKEN from this file at startup (vault/agent injection)
ZOSMF_USER_ID — End-user id for PassTicket identity propagation (RACF sees this user, not the service account)
ZOSMF_PASSTICKET_APP — RACF PTKTDATA application name for PassTicket generation (default ZOSMF)
ZOWE_TEAM_CONFIG — Path to a zowe.config.json to import connection settings from (env vars win)
ZOSMF_PROFILE — Profile name inside the Zowe team config (defaults to defaults.zosmf)
LOG_LEVEL — Log level: fatal, error, warn, info, debug, trace, silent
MCP_TRANSPORT — Transport: stdio (IDE) or sse (legacy HTTP+SSE for container/network deployments)
MCP_SSE_PORT — Listen port when MCP_TRANSPORT=sse
MAX_JOB_OUTPUT_LINES — Max lines returned from a single spool DD
MAX_DATASET_READ_LINES — Max lines returned from dataset or USS reads
MAX_JES_SPOOL_FILES — Max spool files fetched during diagnostics
MAX_AUDIT_LINES — Max RACF audit log lines per query
CMCI_CONTEXT — CICSplex name or region APPLID (required for CICS tools)
CMCI_HOST — CMCI hostname (defaults to ZOSMF_HOST)
CMCI_PORT — CMCI HTTPS port (default 1490)
CMCI_BASE_PATH — CMCI REST base path
DB2_LOCATION — Db2 subsystem location name (required for Db2 tools)
DB2_HOST — Db2 REST hostname (defaults to ZOSMF_HOST)
DB2_PORT — Db2 REST port (default 50400)
DB2_BASE_PATH — Db2 REST base path
SMF_SUMMARY_DATASET — Optional SMF summary dataset for offline metrics
RMF_METRICS_ENABLED — Query z/OSMF RMF metrics when available
RACF_AUDIT_USS_PATH — USS path to RACF audit log file
RACF_AUDIT_DATASET — Sequential dataset containing RACF audit records
SECURITY_READ_ONLY — When true (default), blocks write tools such as submit_jcl
SECURITY_ALLOWED_TOOLS — Comma-separated allowlist of MCP tool names
SECURITY_BLOCKED_TOOLS — Comma-separated blocklist of MCP tool names
SECURITY_ALLOWED_DATASET_PATTERNS — Comma-separated dataset patterns (e.g. USERDEV.*,SYS1.*)
SECURITY_ALLOWED_USS_PATHS — Comma-separated USS path prefixes
SECURITY_AUDIT_LOGGING — Log every tool invocation to stderr (SIEM-friendly JSON)
SECURITY_MAX_JCL_BYTES — Maximum inline JCL size for submit_jcl
SECURITY_WRITE_APPROVAL — Human-in-the-loop: submit_jcl returns a one-time token and approve_write executes (default false)
SECURITY_JCL_SCAN — Pre-flight scan JCL before submission: IDCAMS DELETE, IEFBR14 DISP DELETE, blocked utilities (default true)
SECURITY_JCL_SCAN_STRICT — Strict scan mode: WARN findings also block submissions (default false)
SECURITY_BLOCKED_PROGRAMS — Comma-separated EXEC programs that may never run (extends ADRDSSU,ICKDSF,IEHINITT)
SECURITY_BLOCKED_JOB_CLASSES — Comma-separated JES job classes that may never be used
SECURITY_CHANGE_TICKET_PATTERN — Regex a changeTicket argument must match on writes, e.g. CHG[0-9]{6}
SECURITY_WRITE_WINDOW — Allowed write window, 24h HH:MM-HH:MM (overnight ranges allowed), e.g. 08:00-18:00
SECURITY_WRITE_DAYS — Weekdays writes are allowed: 0=Sun..6=Sat, e.g. 1-5
SECURITY_WRITE_WINDOW_TZ — IANA timezone for the write window (default UTC)

Claude Code has no install link for a local command. Copy the command below and run it in a terminal.

shClaude Code

1ZOSMF_HOST=<value> ZOSMF_PORT=<value> ZOSMF_BASE_PATH=<value> ZOSMF_USER=<value> ZOSMF_PASSWORD=<secret> ZOSMF_TOKEN=<secret> ZOSMF_TOKEN_TYPE=<value> ZOSMF_REJECT_UNAUTHORIZED=<value> ZOSMF_CERT=<value> ZOSMF_CERT_KEY=<value> ZOSMF_TOKEN_FILE=<value> ZOSMF_USER_ID=<value> ZOSMF_PASSTICKET_APP=<value> ZOWE_TEAM_CONFIG=<value> ZOSMF_PROFILE=<value> LOG_LEVEL=<value> MCP_TRANSPORT=<value> MCP_SSE_PORT=<value> MAX_JOB_OUTPUT_LINES=<value> MAX_DATASET_READ_LINES=<value> MAX_JES_SPOOL_FILES=<value> MAX_AUDIT_LINES=<value> CMCI_CONTEXT=<value> CMCI_HOST=<value> CMCI_PORT=<value> CMCI_BASE_PATH=<value> DB2_LOCATION=<value> DB2_HOST=<value> DB2_PORT=<value> DB2_BASE_PATH=<value> SMF_SUMMARY_DATASET=<value> RMF_METRICS_ENABLED=<value> RACF_AUDIT_USS_PATH=<value> RACF_AUDIT_DATASET=<value> SECURITY_READ_ONLY=<value> SECURITY_ALLOWED_TOOLS=<value> SECURITY_BLOCKED_TOOLS=<value> SECURITY_ALLOWED_DATASET_PATTERNS=<value> SECURITY_ALLOWED_USS_PATHS=<value> SECURITY_AUDIT_LOGGING=<value> SECURITY_MAX_JCL_BYTES=<value> SECURITY_WRITE_APPROVAL=<value> SECURITY_JCL_SCAN=<value> SECURITY_JCL_SCAN_STRICT=<value> SECURITY_BLOCKED_PROGRAMS=<value> SECURITY_BLOCKED_JOB_CLASSES=<value> SECURITY_CHANGE_TICKET_PATTERN=<value> SECURITY_WRITE_WINDOW=<value> SECURITY_WRITE_DAYS=<value> SECURITY_WRITE_WINDOW_TZ=<value> claude mcp add io.github.notharshhaa-mainframe-mcp-server -- npx -y @notharshhaa/mainframe-mcp-server@3.0.0

Run in a terminal.

jsonClaude Desktop

1{2  "mcpServers": {3    "io.github.notharshhaa-mainframe-mcp-server": {4      "command": "npx",5      "args": [6        "-y",7        "@notharshhaa/[email protected]"8      ],9      "env": {10        "ZOSMF_HOST": "<value>",11        "ZOSMF_PORT": "<value>",12        "ZOSMF_BASE_PATH": "<value>",13        "ZOSMF_USER": "<value>",14        "ZOSMF_PASSWORD": "<secret>",15        "ZOSMF_TOKEN": "<secret>",16        "ZOSMF_TOKEN_TYPE": "<value>",17        "ZOSMF_REJECT_UNAUTHORIZED": "<value>",18        "ZOSMF_CERT": "<value>",19        "ZOSMF_CERT_KEY": "<value>",20        "ZOSMF_TOKEN_FILE": "<value>",21        "ZOSMF_USER_ID": "<value>",22        "ZOSMF_PASSTICKET_APP": "<value>",23        "ZOWE_TEAM_CONFIG": "<value>",24        "ZOSMF_PROFILE": "<value>",25        "LOG_LEVEL": "<value>",26        "MCP_TRANSPORT": "<value>",27        "MCP_SSE_PORT": "<value>",28        "MAX_JOB_OUTPUT_LINES": "<value>",29        "MAX_DATASET_READ_LINES": "<value>",30        "MAX_JES_SPOOL_FILES": "<value>",31        "MAX_AUDIT_LINES": "<value>",32        "CMCI_CONTEXT": "<value>",33        "CMCI_HOST": "<value>",34        "CMCI_PORT": "<value>",35        "CMCI_BASE_PATH": "<value>",36        "DB2_LOCATION": "<value>",37        "DB2_HOST": "<value>",38        "DB2_PORT": "<value>",39        "DB2_BASE_PATH": "<value>",40        "SMF_SUMMARY_DATASET": "<value>",41        "RMF_METRICS_ENABLED": "<value>",42        "RACF_AUDIT_USS_PATH": "<value>",43        "RACF_AUDIT_DATASET": "<value>",44        "SECURITY_READ_ONLY": "<value>",45        "SECURITY_ALLOWED_TOOLS": "<value>",46        "SECURITY_BLOCKED_TOOLS": "<value>",47        "SECURITY_ALLOWED_DATASET_PATTERNS": "<value>",48        "SECURITY_ALLOWED_USS_PATHS": "<value>",49        "SECURITY_AUDIT_LOGGING": "<value>",50        "SECURITY_MAX_JCL_BYTES": "<value>",51        "SECURITY_WRITE_APPROVAL": "<value>",52        "SECURITY_JCL_SCAN": "<value>",53        "SECURITY_JCL_SCAN_STRICT": "<value>",54        "SECURITY_BLOCKED_PROGRAMS": "<value>",55        "SECURITY_BLOCKED_JOB_CLASSES": "<value>",56        "SECURITY_CHANGE_TICKET_PATTERN": "<value>",57        "SECURITY_WRITE_WINDOW": "<value>",58        "SECURITY_WRITE_DAYS": "<value>",59        "SECURITY_WRITE_WINDOW_TZ": "<value>"60      }61    }62  }63}

claude_desktop_config.json

Local · npmPublisher installStep-by-step: add this in Claude

Remote URL or a command on your machine? How the two installs differ

Tools

No tool list yet. Remote servers get one after the first health check.

FAQ

Mainframe