Ibm As 400 Iseries MCP Server

🚀 IBM AS/400 ISeries MCP Server

This project implements a customizable MCP server for executing the RTE protocol, offering flexibility and extensibility for RTE-related operations.

✨ Features

• Customizable MCP server for RTE protocol execution.
• Easily extensible with the RteUtils class to add custom MCP tools.
• Supports multiple protocols (TN5250, TN3270, VT420) and terminal types.
• Can run in SSE and STDIO modes.

💻 Usage Examples

Basic Usage

Here are some visual examples demonstrating the project:

📦 Installation

Requirements

• Java 21+

Run

• Compile the project:

./mvnw clean package

• Run the server in SSE mode:

java -jar target/rte-mcp-server-0.0.1-SNAPSHOT.jar

• Run the server in STDIO mode:

java -jar -Dspring.ai.mcp.server.stdio=true rte-mcp-server-0.0.1-SNAPSHOT.jar

📚 Documentation

RteUtils

The project is designed to be easily extensible. You can add your own MCP tools using the RteUtils class. It's also necessary to define the RTE connection parameters and the RTE flow in a yaml format.

RteUtils has the following methods implemented:

• static RteProtocolClient connect(RteConfig config): Connects to the RTE server using the provided yaml.
• static String executeSteps(RteProtocolClient client, List<RteStep> steps): Executes the provided steps on the RTE server and returns the screen result as a string using the provided yaml.

The method exposed as an MCP tool should be annotated as @Tool, and the class should be annotated as @Services, as shown in the following example:

@Service
public class RteServiceLoginTool implements RteTool {

  private static final Logger logger = LoggerFactory.getLogger(RteServiceLoginTool.class);

  @Tool(description = "Execute an RTE transaction in a given server", name = "TN5250 Login")
  public String executeRteTransaction(String server, int port) {
    try {
      RteFlow flow = RteYamlLoader.load("/flow.yaml");
      RteProtocolClient client = RteTool.connect(flow.getConfig(), server, port);
      return RteTool.executeSteps(client, flow.getSteps());
    } catch (IOException | RteIOException | InterruptedException | TimeoutException e) {
      logger.error("Error executing RTE flow", e);
      return "Error executing RTE flow: " + e.getMessage();
    }
  }
}

The yaml file defines the connection parameters and the steps to execute on the RTE server. It should have the following structure:

config:
  server: localhost
  port: 2324
  protocol: TN5250
  terminalType: 'IBM-3477-FC: 27x132'
  sslType: None

steps:
  - actions:
      - label: User
        input: TESTUSR
      - label: Password
        input: TESTPSW
    attentionKey: ENTER

YAML Configuration Details

• server: The server address for connecting to the RTE server.
• port: The port for connecting to the RTE server.
• protocol: Supported protocols are TN5250, TN3270, and VT420.
• terminalType: The following table shows the supported terminal types for each protocol: | Protocol | Terminal Type | |----------|-----------------------| | TN5250 | IBM-3477-FC: 27x132 | | | IBM-3179-2: 24x80 | | TN3270 | IBM-3278-M2: 24x80 | | | IBM-3278-M2-E: 24x80 | | | IBM-3278-M3: 32x80 | | | IBM-3278-M3-E: 32x80 | | | IBM-3278-M4: 43x80 | | | IBM-3278-M4-E: 43x80 | | | IBM-3278-M5: 27x132 | | | IBM-3278-M5-E: 27x132 | | VT420 | VT420-7: 24x80 |
• sslType: Supported ssl types are None, TLS, and SSLv3.
• steps: A list of actions representing the steps to execute on the RTE server.
• actions: All actions to execute on the current screen. Any number of label/input pairs can be added.
  • label: The label of the field to fill in the RTE screen.
  • input: The value to fill in the field.
  • attentionKey: The key to press after filling the fields. It can be ENTER, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21, F22, F23, F24, ATTN, CLEAR, SYSRQ, RESET, ROLL_UP, ROLL_DN, PA1, PA2, or PA3.

🔧 Technical Details

The project uses Java and Spring frameworks to build the MCP server. The RteUtils class provides a set of utility methods for interacting with the RTE server, while the @Tool and @Service annotations are used to expose custom MCP tools. The YAML configuration file is used to define the RTE connection parameters and execution steps, providing a flexible and easy-to-configure way for users.

🧪 Testing

An example of an integration test is provided in the RteServiceLoginToolTest class. This test uses the MCPClient to validate the list of tools and execute them.

⚠️ Important Note

To test the behavior of the tool, it is recommended to generate a dump of the RTE flow to be executed and mock it using wiresham.

More information on how to test and debug the server can be found here.