Zowe MCP Server

使用说明（简要版，便于快速上手）

• 项目简介

  • 这是一个完整的后端服务器实现，按照 Model Context Protocol（MCP）标准暴露资源、工具和提示模板，供大型语言模型（LLM）客户端以统一的接口进行查询、调用和渲染。
  • 服务器内置了大量与 z/OS 主机环境相关的工具集（如 JOB、DATASET、TSO、USS、DB2 等），并提供错误代码解释、日志分析等智能能力。还包含 Mock 模式，便于演示和开发。
  • 服务器通过基于 MCP 的接口提供“读取资源、注册与执行工具、获取和渲染 Prompt 模板”的核心能力。

• 主要功能点（通俗版）

  • 资源（Resources）：提供参考材料与文档（如数据集类型、JCL、COBOL、ABEND/返回码等的参考内容）。
  • 工具（Tools）：暴露一系列与 z/OS 交互的工具，如列出/job 状态、读取数据集、提交 JCL、访问 JES spool、TSO/控制台命令、USS 文件等，并具有输入校验、结果格式化和错误处理。
  • 提示模板（Prompts）：预设的对话工作流示例（如 Onboarding、诊断作业失败、代码审查等），可直接用于与 LLM 的对话。
  • 错误参考与分析：能够解释 ABEND、返回码等，并对作业输出进行自动分析，给出可能的原因和修复建议。
  • Mock 模式：在无真实主机环境时，仍可通过预设的模拟数据进行演示和开发。
  • 多传输与兼容性：当前实现以 Stdio 传输为主，便于 Claude Desktop 等工具接入，同时具备未来扩展为 SSE/WebSocket 的能力。

• 安装步骤

  • 依赖与构建：使用 bun 进行安装和构建（与仓库提供的快速入门一致）。
  • 运行方式：在本地构建完成后，可以直接以服务器进程的方式运行，通过 MCP 客户端进行连接。

• 服务器配置（用于 MCP 客户端连接的 JSON 配置，示例字段如下） 说明：MCP 客户端需要一个描述服务器启动命令和参数的配置。该配置不需要在服务端代码中硬编码，客户端可通过该 JSON 指定如何启动并连接到服务器。

  • server 名称：zowe-mcp-server
  • 启动命令（command）：npx
  • 启动参数（args）：["-y","@gestell/zowe-mcp"]

  以上配置示例在客户端可直接使用的 JSON 结构如下（仅文本描述，便于理解，不作为代码块显示）： { "name": "zowe-mcp-server", "command": "npx", "args": ["-y", "@gestell/zowe-mcp"], "description": "MCP 服务端，用于向客户端暴露资源、工具和 prompts，支持与 Zowe/MCP 客户端的交互。" }

  说明与注意事项：

  • MCP 客户端通过上述启动命令启动服务器，并与服务器进行基于 JSON-RPC 的请求/响应通信。
  • 服务器的实现中，当前默认使用 StdioServerTransport 作为传输通道（便于 Claude Desktop 等在本地通过标准输入/输出与服务器通信）。如需，后续也可扩展到 SSE/WebSocket 等传输协议。
  • 服务器在运行时会区分 MOCK 模式和 LIVE 模式；MOCK 模式下会使用内置的模拟数据替代对真实 z/OS 的调用，便于演示和本地开发。
  • 服务器提供了丰富的输入模式校验（通过 Zod schemas）来确保工具调用的输入合法性，且对错误输出进行统一封装与解释。

• 基本使用方法

  • 客户端配置好服务器启动命令后，使用 LLM 客户端（如 Claude）与 MCP 服务器进行 JSON-RPC 调用，利用工具、资源和提示模板完成交互式工作流。
  • 通过工具执行结果，可以查看原始输出、结构化数据、以及自动分析/解释结果（如 ABEND、COND CODE、I/O 错误等）。
  • Mock 模式下不需要真实的 Zowe/主机环境，即可进行完整的对话与演示。

• 运行与测试要点（高层）

  • 服务器实现包含多个核心模块：工具注册、提示注册、资源注册、以及错误参考服务，整体遵循 MCP 的服务注册/工具注册模式。
  • 核心入口在 src/index.ts，构建后即可作为独立 MCP 服务器启动。
  • 测试用例覆盖了大量工具交互、错误解释、端到端演示流程等，确保功能在 Mock 模式下也能完整演示。