Back to Directory/Developer Tools

io.github.ExpertVagabond/ibmz

IBM Z mainframe MCP server - Key Protect HSM & z/OS

Developer ToolsRustv1.0.1

ibmz-mcp-server

[!License: MIT](https://opensource.org/licenses/MIT) [!MCP](https://modelcontextprotocol.io) [!npm](https://www.npmjs.com/package/ibmz-mcp-server)

MCP server for IBM Z mainframe integration. Provides HSM-backed key management via IBM Key Protect (FIPS 140-2 Level 3) and REST API access to mainframe programs (CICS, IMS, batch) via z/OS Connect.

Tools (12 total)

Key Protect -- HSM Key Management

ToolDescription
key_protect_list_keysList encryption keys in Key Protect
key_protect_create_keyCreate root or standard keys
key_protect_get_keyGet key details and metadata
key_protect_wrap_keyWrap (encrypt) a DEK with a root key
key_protect_unwrap_keyUnwrap (decrypt) a wrapped DEK
key_protect_rotate_keyRotate a root key
key_protect_delete_keyDelete a key (irreversible)
key_protect_get_key_policiesGet rotation and dual-auth policies

z/OS Connect -- Mainframe Integration

ToolDescription
zos_connect_list_servicesList available mainframe services
zos_connect_get_serviceGet service details and OpenAPI spec
zos_connect_call_serviceCall a mainframe program via REST (JSON to COBOL)
zos_connect_list_apisList outbound API configurations
zos_connect_healthCheck z/OS Connect server health

Install

npm install

Configuration

{
  "mcpServers": {
    "ibmz": {
      "type": "stdio",
      "command": "node",
      "args": ["/path/to/ibmz-mcp-server/index.js"],
      "env": {
        "IBM_CLOUD_API_KEY": "your-api-key",
        "KEY_PROTECT_INSTANCE_ID": "your-instance-id",
        "KEY_PROTECT_URL": "https://us-south.kms.cloud.ibm.com"
      }
    }
  }
}

Environment Variables

VariableDescriptionRequired
IBM_CLOUD_API_KEYIBM Cloud API keyYes (Key Protect)
KEY_PROTECT_INSTANCE_IDKey Protect instance OCIDYes (Key Protect)
KEY_PROTECT_URLKey Protect endpointNo (defaults to us-south)
ZOS_CONNECT_URLz/OS Connect base URLYes (z/OS Connect)
ZOS_CONNECT_USERNAMEMainframe usernameYes (z/OS Connect)
ZOS_CONNECT_PASSWORDMainframe passwordYes (z/OS Connect)

Key Concepts

Envelope Encryption

Root keys (KEK) are stored in the HSM and never leave the hardware. Data encryption keys (DEK) are wrapped by root keys for safe storage alongside ciphertext.

z/OS Connect

REST APIs that automatically map JSON payloads to COBOL copybooks, enabling access to CICS transactions, IMS programs, and batch jobs.

Dependencies

  • @modelcontextprotocol/sdk -- MCP protocol SDK
  • @ibm-cloud/ibm-key-protect -- Key Protect client
  • ibm-cloud-sdk-core -- IBM Cloud authentication

License

MIT

Installation

Source-derived launch command. Check the maintainer’s required arguments and credentials before running:

bash
npx -y ibmz-mcp-server

Set up in your AI client

Merge this template into ~/Library/Application Support/Claude/claude_desktop_config.json. Keep existing servers. Add any arguments, credentials, and permissions required by the maintainer; this template has not been install-tested.

json
{
  "mcpServers": {
    "io-github-expertvagabond-ibmz": {
      "command": "npx",
      "args": [
        "-y",
        "ibmz-mcp-server"
      ]
    }
  }
}

Restart Claude Desktop completely for changes to take effect. Confirm the server appears connected in the client’s tool list, then try a read-only example from its documentation.

Claude Desktop setup reference

Package

ibmz-mcp-servernpm

Compatible MCP Clients

io.github.ExpertVagabond/ibmz works with any MCP-compatible client. Copy the config snippet from the Configuration section above and add it to the file shown for your client, then restart the application.

  • Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.jsonRestart Claude Desktop completely for changes to take effect.
  • Cursor~/.cursor/mcp.jsonRestart Cursor for changes to take effect.
  • VS Code.vscode/mcp.jsonReload VS Code window for changes to take effect.
  • Windsurf~/.codeium/windsurf/mcp_config.jsonRestart Windsurf for changes to take effect.
  • Claude Code.mcp.jsonSave at the project root, then start Claude Code in that project and review the MCP server approval prompt. Keep real credentials out of shared files.

Learn More