MCP server providing 5250 terminal access to IBM i systems
Project description
ibmi-mcp
Give your AI Agent terminal access to your IBM i system via TN5250.
ibmi-mcp is an MCP server that lets AI Agents like Claude interact with IBM i the same way a human would through a 5250 green-screen terminal.
Installation
Install from PyPI:
pip install ibmi-mcp
Then register it with Claude Code:
claude mcp add ibmi-5250 -- uvx ibmi-mcp
Configuration
Configure the connection using environment variables:
| Variable | Description | Required | Default |
|---|---|---|---|
IBMI_HOST |
IBM i hostname or IP | Yes | — |
IBMI_PORT |
TN5250 port | No | 23 |
IBMI_SSL |
Enable TLS | No | false |
IBMI_USER |
Username for auto-signon | No | — |
IBMI_PASSWORD |
Password for auto-signon | No | — |
IBMI_DEVICE_NAME |
Virtual device name | No | — |
IBMI_CODEPAGE |
EBCDIC codepage | No | cp037 |
IBMI_TERMINAL_TYPE |
Terminal type | No | IBM-3179-2 |
When IBMI_USER and IBMI_PASSWORD are set, ibmi-mcp will automatically sign on when it detects a login screen after connecting.
Tools
| Tool | Description |
|---|---|
connect |
Connect to an IBM i system via TN5250 |
disconnect |
Disconnect the active session |
read_screen |
Read the current screen content and input fields |
send_keys |
Type text into the current input field |
send_key |
Send a function/attention key (Enter, F1-F24, PageUp, PageDown, Tab, etc.) |
set_cursor |
Position the cursor at a specific row and column |
Features
- Auto-signon — Automatically detects sign-on screens and logs in with configured credentials
- Full key support — Enter, F1-F24, PageUp, PageDown, Tab, Backtab, Clear, Help, Print, Attn
- Local editing — Backspace, Delete, Field Exit, Home, and End handled locally for responsive editing
- Structured screen data — Returns screen text, cursor position, and input field metadata
- Configurable codepage — Supports EBCDIC codepage translation (default: CP037)
License
BSD 2-Clause. See LICENSE for details.
About Whitehorn Ltd. Co.
ibmi-mcp is developed and maintained by Whitehorn Ltd. Co., a legacy system modernization firm. We specialize in IBM i, RPG, COBOL, and midrange platforms. We help our clients protect what they can't afford to break while building a path forward.
Learn more about how Whitehorn Ltd. Co. can help you modernize your IBM midrange systems at whitehorn.ltd.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ibmi_mcp-1.0.0.tar.gz.
File metadata
- Download URL: ibmi_mcp-1.0.0.tar.gz
- Upload date:
- Size: 27.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Hatch/1.16.5 cpython/3.10.14 HTTPX/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c82cbf69ab338eb66bb8cacebf2d0c638612fb82bc9e198af12dafbf357f0922
|
|
| MD5 |
56e268a558fdd2978d93b184c748b3f7
|
|
| BLAKE2b-256 |
4950343a8d2be068b7bc323f46aace445f349556e37a9eb0b3c537be4eae6fc9
|
File details
Details for the file ibmi_mcp-1.0.0-py3-none-any.whl.
File metadata
- Download URL: ibmi_mcp-1.0.0-py3-none-any.whl
- Upload date:
- Size: 20.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: Hatch/1.16.5 cpython/3.10.14 HTTPX/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e4d2adbf549a88428b79e788d24dd9a5d55f184e34d956ec7f61f0f940c59d5
|
|
| MD5 |
72ea25061f76d7e08265e754c9bfc767
|
|
| BLAKE2b-256 |
75a3b917d585a3692619656ba041af5ffd7486c8bd9ebfb03c5bd2c2a2217669
|
