npm ibmz-mcp-serverstdioMITupdated 11d ago
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.
What can you do with ibmz?
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
| Tool | Description |
|---|---|
key_protect_list_keys |
List encryption keys in Key Protect |
key_protect_create_key |
Create root or standard keys |
key_protect_get_key |
Get key details and metadata |
key_protect_wrap_key |
Wrap (encrypt) a DEK with a root key |
key_protect_unwrap_key |
Unwrap (decrypt) a wrapped DEK |
key_protect_rotate_key |
Rotate a root key |
key_protect_delete_key |
Delete a key (irreversible) |
key_protect_get_key_policies |
Get rotation and dual-auth policies |
z/OS Connect -- Mainframe Integration
| Tool | Description |
|---|---|
zos_connect_list_services |
List available mainframe services |
zos_connect_get_service |
Get service details and OpenAPI spec |
zos_connect_call_service |
Call a mainframe program via REST (JSON to COBOL) |
zos_connect_list_apis |
List outbound API configurations |
zos_connect_health |
Check 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
| Variable | Description | Required |
|---|---|---|
IBM_CLOUD_API_KEY |
IBM Cloud API key | Yes (Key Protect) |
KEY_PROTECT_INSTANCE_ID |
Key Protect instance OCID | Yes (Key Protect) |
KEY_PROTECT_URL |
Key Protect endpoint | No (defaults to us-south) |
ZOS_CONNECT_URL |
z/OS Connect base URL | Yes (z/OS Connect) |
ZOS_CONNECT_USERNAME |
Mainframe username | Yes (z/OS Connect) |
ZOS_CONNECT_PASSWORD |
Mainframe password | Yes (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 clientibm-cloud-sdk-core-- IBM Cloud authentication
License
Install
Add ibmz to your client. Pick the one you use.
claude mcp add ibmz-mcp-server -- npx -y ibmz-mcp-servercodex mcp add ibmz-mcp-server -- npx -y ibmz-mcp-serveramp mcp add ibmz-mcp-server -- npx -y ibmz-mcp-server{
"mcpServers": {
"ibmz-mcp-server": {
"command": "npx",
"args": [
"-y",
"ibmz-mcp-server"
]
}
}
}Add to `claude_desktop_config.json`, then restart Claude Desktop.
{
"mcpServers": {
"ibmz-mcp-server": {
"command": "npx",
"args": [
"-y",
"ibmz-mcp-server"
]
}
}
}Add to `~/.cursor/mcp.json`, or `.cursor/mcp.json` for a single project.
code --add-mcp '{"name":"ibmz-mcp-server","command":"npx","args":["-y","ibmz-mcp-server"]}'Or add the block manually to `.vscode/mcp.json` under `servers`.
{
"mcpServers": {
"ibmz-mcp-server": {
"command": "npx",
"args": [
"-y",
"ibmz-mcp-server"
]
}
}
}Add to `~/.codeium/windsurf/mcp_config.json`.
{
"mcpServers": {
"ibmz-mcp-server": {
"command": "npx",
"args": [
"-y",
"ibmz-mcp-server"
]
}
}
}Add to `cline_mcp_settings.json` via the MCP Servers panel.
{
"mcpServers": {
"ibmz-mcp-server": {
"command": "npx",
"args": [
"-y",
"ibmz-mcp-server"
]
}
}
}Add to `~/.gemini/settings.json`.
{
"mcpServers": {
"ibmz-mcp-server": {
"type": "local",
"command": "npx",
"args": [
"-y",
"ibmz-mcp-server"
],
"tools": [
"*"
]
}
}
}Add to `~/.copilot/mcp-config.json`, or run `/mcp add` inside the CLI.
{
"context_servers": {
"ibmz-mcp-server": {
"command": {
"path": "npx",
"args": [
"-y",
"ibmz-mcp-server"
]
}
}
}
}Add to your Zed `settings.json`.
npx -y ibmz-mcp-serverRun `goose configure`, choose **Add Extension ā Command-line Extension**, and paste this command.
Score
39 / 100
Incomplete
- Documentation22/25
- Maintenance19/25
- Trust13/20
- Capability0/15
- Install experience12/15
- Documents what it does and how to connect
- Has a resolvable package or endpoint
- Exposes at least one tool, prompt or resource
- README has substantive content
- Includes a code example
- Documents its configuration
- Mentions credentials or security posture
- Last commit 3 days ago
- Has a release history
- Repository is not archived
- Licensed MIT
- Namespace verified in the official MCP registry
- Claimed by its owner
- Published under an organisation
- 0 tool(s) documented
- Provides prompt templates
- Provides resources
- 12 documented install method(s)
- Published to a package registry
- Offers a hosted endpoint ā no local install
Version history
| Versions | Published |
|---|---|
| 1.0.1Latest | Feb 14, 2026 |