These are all the Model Context Protocol (MCP) capabilities available in Z Open Editor. See the section Agent Mode for details.
You can ask about your Zowe™ Client profiles to see what is available, what is in use by Z Open Editor, and to obtain or retire JSON Web Token (JWT) authentication.
| Tool Name | Tool Description |
|---|
zowe-get-default-profile <type> | Retrieve the default Zowe profile of a given type as configured in the Zowe team configuration files, defaults to type RSE. |
zopeneditor-get-default-zowe-profile | Retrieve IBM Z® Open Editor's default Zowe profile as configured in the zopeneditor.zowe user settings. |
zowe-profile-connection-check | Retrieve the status of the connection to the Rest API server. You can optionally specify profileName to run the check with a profile other than the IBM Z Open Editor default Zowe profile. |
zowe-list-profiles <type> | List Zowe profiles configured in the Zowe team configuration file by type. Defaults to all profiles. |
zowe-profile-login | Log in with the editor's set profile to obtain a JWT. You can optionally specify profileName to log in with a profile other than the IBM Z Open Editor default Zowe profile. |
zowe-profile-logout | Log out from the server with the editor's set profile and remove the JWT from the team configuration file. You can optionally specify profileName to log out with a profile other than the IBM Z Open Editor default Zowe profile. |
zopeneditor-change-default-zowe-profile | Change the IBM Z Open Editor default Zowe profile. |
zowe-create-team-config | Launch the Zowe Explorer interactive team configuration creation workflow. |
zowe-update-basic-credentials | Securely update username and password with the Zowe Explorer interactive VS Code prompts. Credentials are securely stored and never exposed to LLMs. |
zowe-update-profile | Update non-sensitive profile connection properties (host, port, protocol, etc.). |
You can manage data sets and members on z/OS® and run TSO commands. All of these commands accept the optional profileName argument to specify the profile to use. If no profile is specified, the IBM Z Open Editor default profile is used.
| Tool Name | Tool Description |
|---|
zowe-list-datasets <filter> | Retrieve data sets that match the specified filter pattern. |
zowe-list-members <dataSetName> | List members of the specified data set. |
zowe-get-dataset-content <mvsFileName> | Retrieve the contents of the specified SEQ or PDS member. You can optionally specify the file parameter to download the content to a local location. |
zowe-allocate-like-dataset <dataSetName> <existingDataSet> | Allocate a new specified data set similar to an existing one. |
zowe-issue-tso-command <command> | Run the specified TSO command. |
zowe-search-dataset <pattern> <searchString> | Search data sets for content using a string or regex pattern. Optional parameters include: regex (default false), caseSensitive (default false), searchExactName (default true), mainframeSearch (default false), getOptions, and listOptions. |
zowe-upload-dataset <localPath> <dataSetName> | Upload a local file to a data set. |
You can manage files and directories in z/OS UNIX System Services and run UNIX System Services commands. Each command accepts the optional profileName argument to specify the profile to use. If no profile is specified, the IBM Z Open Editor default profile is used.
| Tool Name | Tool Description |
|---|
zowe-list-unix-files <filePath> | List the UNIX System Services files in the specified path. |
zowe-upload-unix-files <localPath> <unixPath> | Upload a local file to the specified location on UNIX System Services. |
zowe-create-unix-path <unixPath> <type> <permissions> | Create a specified UNIX System Services file or directory at the specified path. Specify whether it is a file or directory. Permissions are optional; if omitted, the default value 'rwxrw-r--' is used. |
zowe-get-unix-file-content <unixPath> | Download the contents of the specified UNIX System Services file. You can use the optional file parameter to specify a local location to download content. |
zowe-issue-unix-command <unixCommand> | Run the specified UNIX System Services command on the system. |
zowe-upload-folder-to-unix <localFolderPath> <unixFolderPath> | Upload a local folder to the specified location on UNIX System Services. |
You can get information about z/OS jobs and spool files. Each command accepts the optional profileName argument to specify the profile to use. If no profile is specified, the IBM Z Open Editor default profile is used.
| Tool Name | Tool Description |
|---|
zowe-list-jobs <owner> <status> <jobName> <jobId> | Retrieve jobs that match the specified owner, job status, job name, or job ID. If no parameters are specified, the command returns the jobs for the current user (owner) as defined in profile. |
zowe-submit-dataset <dataSet> | Submit a job from the specified data set. |
zowe-purge-job <jobName> <jobId> | Purge the job identified by the given job name and job ID. |
zowe-submit-jcl <jclString> | Submit a job for the given local JCL. |
zowe-list-job-spools <jobName> <jobId> | Retrieve the spools files for the specified job name and/or job ID. |
zowe-get-single-job-spool-output <jobName> <jobId> <spoolId> | Retrieve the output of a job spool for the specified job name and/or job ID, and spool ID. |
zowe-get-all-job-spools-output <jobName> <jobId> <spoolId> | Retrieve the output of all job spools for the specified job name and/or job ID. You can use the optional outDir parameter to specify a local directory to download files. |
All of these commands accept the optional profileName argument to specify the profile to use. If no profile is specified, the IBM Z Open Editor default profile is used.
| Tool Name | Tool Description |
|---|
rseapi-get-system-resource-consumption | Run DISPLAYACTIVE to retrieve system address space resource consumption information. This command is available only with an RSE profile. |
rseapi-get-all-job-resource-consumption | Run DISPLAYACTIVE to retrieve resource consumption information for all active job address spaces. Only available with an RSE profile. |
rseapi-download-unix-folder <unixFolderPath> <localFolderPath> | Download the specified z/OS UNIX System Services folder to the specified local folder. Optional parameters include binaryMode, runInBackground, maxConcurrency, and overwriteExisting. |
You can ask about the property groups defined in your ZAPP files. This works across all ZAPP files in a multi-root workspace. You can ask the AI to list the locations it searches for include files and combine the result with the log file resource for troubleshooting.
| Tool Name | Tool Description |
|---|
zapp-get-property-groups <language> | List all property groups defined for the specified language (required) in all workspaces. |
You can access Z Open Editor's log file for troubleshooting by asking your AI questions about the editor's configuration and how it performed tasks, such as searching for include files using property groups from ZAPP files. You can also inquire about how features are configured or enabled in Z Open Editor. Depending on the Chat agent, it might prefer to run the MCP tool to read the log file or use the MCP Resource, both options are available.
For the best results, run the Z Open Editor logger in DEBUG mode as described in Troubleshooting using log files.
| Tool Name | Tool Description |
|---|
zopeneditor-read-the-log | Read the current Z Open Editor log file and search the content. |
| Resource Name | Description |
|---|
zopeneditor.log | The log file for Z Open Editor referred to as zopeneditor.log that can be used for troubleshooting and configuration information. |
Data Elements view
If you are analyzing your program, perhaps using code explanations tools, you can also ask the API to open Z Open Editor's Data Elements view to get a sortable representation of the program's symbols that can be filtered and searched.
| Tool Name | Tool Description |
|---|
zopeneditor-show-data-elements-view | Open the Data Elements view for a program specified by name or the currently open program. |
| Tool Name | Tool Description |
|---|
dbb-get-build-result <buildResult> <buildGroup> | Gets an IBM Dependency Based Build (DBB) build result that collects the metadata information of a DBB build. |
dbb-get-last-failed-build-result <buildGroup> | Gets the last failed IBM Dependency Based Build (DBB) build result, which collects the metadata information of the last failed DBB build in a particular DBB group. |
dbb-download-build-result-attachments <buildResult> <buildGroup> | Exports all of the attachments from an IBM Dependency Based Build (DBB) build result on a remote environment and downloads them to a local folder. The path to the local folder is returned from this tool. |
User build
| Tool Name | Tool Description |
|---|
userbuild-run-user-build <buildFile> <fullUpload> | Runs a DBB user build on a file and returns the runtime report of its execution. Before execution, ask the user whether they want to perform a full upload, providing a button prompt for them to click if supported by the LLM. If the build succeeds, summarize its execution. If an error occurs as recorded in the runtime report, explain how the error occurred and how the user might fix it. If log files contain error information relevant to diagnosing the issue, ask the user whether they want you to read them and provide further analysis. If "errorFeedback" information is returned, it is saved in the user's VS Code Problems view for the file that was built. Pay special attention to the information in the "importantNotices" section of this tool's output, this is the most important information. |
userbuild-get-dbb-log <filename> | Returns the contents of a DBB log from the most recent user build. These logs are downloaded from the remote host and stored in a local log directory after a user build. They provide detailed troubleshooting information on build steps such as compilation error logs. |
Connecting your AI to parsed program metadata enables deeper analysis and provide accurate insights into your programs. These tools answer queries about the impact of modifying data items and help analyze program structure.
| Tool Name | Tool Description |
|---|
zopeneditor-cobol-get-data-flow <programName> <dataItemName> <line> <character> | Traces data flow for a specific COBOL data item and returns a graph representation of how the item is modified in the program. Use this tool to analyze the impact of modifying COBOL data items or to summarize how they are used. |
zopeneditor-cobol-get-program-control-flow <programName> <includeExitNodes> | Retrieves parsed control flow data from the COBOL Language Server to analyze program structure and execution paths. |
zopeneditor-pli-get-program-control-flow <programName> <includeExitNodes> | Retrieves parsed control flow data from the PL/I Language Server to analyze program structure and execution paths. |
| Tool Name | Tool Description |
|---|
zopeneditor-get-embedded-languages <programName> | Detects embedded languages in a COBOL or PL/I file. This tool identifies whether a COBOL or PL/I program contains CICS, SQL, DLI, or MQ operations. |
zopeneditor-cobol-renumber-file <leftArea> <rightArea> <programName> | Renumbers a COBOL file using the COBOL Language Server to add sequence numbers to every line in the file. Sequence numbers can be inserted in the left column, the right column, or both. The tool expects a filename with or without a file extension. |
zopeneditor-cobol-unnumber-file <leftArea> <rightArea> <programName> | Removes sequence numbers from every line in a COBOL file using the COBOL Language Server. Sequence numbers can be removed from the left column, the right column, or both. The tool expects a filename with or without a file extension. |
zopeneditor-cobol-format-file <programName> | Formats a COBOL file using the COBOL Language Server and a Z Code Format file. The tool expects a filename with or without the file extension, and it also expects the user to have a Z Code Format file named zcodeformat.yaml or zcodeformat.json in the workspace. See Experimental: Formatting COBOL source code. |
zopeneditor-cobol-renumber-multiple-files <leftArea> <rightArea> <searchPatterns> | Renumbers multiple COBOL files in the workspace using the COBOL Language Server. Sequence numbers are added to every line in the files and can be inserted in the left column, the right column, or both. The tool expects a list of filenames or a glob pattern to search the workspace. |
zopeneditor-cobol-unnumber-multiple-files <leftArea> <rightArea> <searchPatterns> | Removes sequence numbers from every line in multiple COBOL files in the workspace using the COBOL Language Server. Sequence numbers can be removed from the left column, the right column, or both. The tool expects a list of filenames or a glob pattern to search the workspace. |
zopeneditor-cobol-format-multiple-files <searchPatterns> | Formats multiple COBOL files using the COBOL Language Server and a Z Code Format file. The tool expects a list of filenames or a glob pattern to search the workspace, and it also expects the user to have a Z Code Format file named zcodeformat.yaml or zcodeformat.json in the workspace. See Experimental: Formatting COBOL source code. |
zcodescan-check-current-program | Run an IBM ZCodeScan on the COBOL or PL/I program file currently open in the editor. The scan parses the program and returns linter-style issues about the quality of the program. Use the results returned to provide a detailed summary of the problems found and propose ways to fix them referencing COBOL or PL/I best practices. If possible provide examples for how the problems described could be fixed. If the scan results contain errors, list the error code and message. |
zcodescan-check-list-of-local-programs <searchPatterns> | Run an IBM ZCodeScan on COBOL or PL/I files in your local workspace. The files are identifies by a list of Glob search patterns that define all the programs to be scanned in the editor workspace. The scan parses all programs and returns linter-style issues about the quality of the programs. Use the results returned to provide a detailed summary of the problems found and propose ways to fix them referencing COBOL or PL/I best practices. Group the results by listing the most significant problems by severity and number of occurrences found. If possible provide examples for how the problems described could be fixed. If the scan results contain errors, list the error code and message. |
| Tool Name | Tool Description |
|---|
check-evidence-version | Checks and returns the "wazideploy-evidence" version on the system. |
index-evidence-folder | Indexes the evidence folder defined in user settings. The Data Folder and Index Folder must be defined. Returns information on modified files. This tool must be run before any queries. |
list-deployments <status> <environment_name> <artifact_name> <artifact_type> <application_name> <application_version> <package_path> <deployed_before YYYYMMDD.HHmmSS.sss> <deployed_after YYYYMMDD.HHmmSS.sss> <history true|false> | Lists deployments in reverse chronological order. Includes deploy timestamp, evidence file path, environment name, application name and version, package path, deployment end status, and deployed artifacts (<name>.<type>). By default, only deployments with end status Ok are returned. Supports filtering by status, environment name, artifact name, artifact type, application name, application version, package path, deployment time range, and history flag. Glob patterns are accepted for string filters. Outputs a multi-document YAML description with one document per deployment. |
list-environments <environment_name> <artifact_name> <artifact_type> <application_name> <application_version> <package_path> <deployed_before YYYYMMDD.HHmmSS.sss> <deployed_after YYYYMMDD.HHmmSS.sss> <history true|false> | Lists environments in ascending alphanumerical order. Includes deployed artifacts (<name>.<type>), deploy timestamp, application name and version, and package path. Supports filtering by environment name, artifact name, artifact type, application name, application_version, package path, deployment time range, and history flag. Glob patterns are accepted for string filters. Outputs a multi-document YAML description with one document per environment. Depending on the history flag, each artifact includes either the last deployment details or the full chronological list of deployments. |
list-artifacts <artifact_name> <artifact_type> <environment_name> <application_name> <application_version> <package_path> <deployed_before YYYYMMDD.HHmmSS.sss> <deployed_after YYYYMMDD.HHmmSS.sss> <history true|false> | Lists deployed artifacts in ascending alphanumerical order of <name>.<type>. Includes environment name, deploy timestamp, application name and version, and deployed package path. Supports filtering by artifact name, artifact type, environment name, application name, application version, package path, deployment time range, and history flag. Glob patterns are accepted for string filters. Outputs a multi-document YAML description with one document per artifact. Each document contains the artifact (artifact) and a list of environments (environments). Depending on the history flag, each environment includes either the last deployment details or the full chronological list of deployments. |
list-packages <artifact_name> <artifact_type> <environment_name> <application_name> <application_version> <package_path> <deployed_before YYYYMMDD.HHmmSS.sss> <deployed_after YYYYMMDD.HHmmSS.sss> <history true|false> | Lists deployed package paths in ascending alphanumerical order. Includes application name and version, artifact names, deploy timestamp, and environment name. Supports filtering by artifact name, artifact type, environment name, application name, application version, package path, deployment time range, and history flag. Glob patterns are accepted for string filters. Outputs a multi-document YAML description with one document per package path. Each document contains the package path (package_path), a list of artifacts, and a list of environments (environments). Depending on the history flag, each environment includes either the last deployment timestamp or the full list of deployment timestamps in chronological order. |
list-failures <limit number> <environment_name> <application_name> <application_version> <package_path> <deployed_before YYYYMMDD.HHmmSS.sss> <deployed_after YYYYMMDD.HHmmSS.sss> | Lists deployment failures in reverse chronological order. Includes deploy timestamp, target environment name, failure location, and detailed failure data. By default, returns the last 10 failures; use limit 0 for no limit. Supports filtering by environment name, application name, application version, package path, and deployment time range. Glob patterns are accepted for string filters. Outputs a multi-document YAML description with one document per deployment. Each document contains the deploy timestamp (deploy_timestamp), environment name (environment_name), and a list of failures (failures) with location and detailed information. |
list-field-values <fieldname> <parent_fieldname> | Lists all values of a specified field. The fieldname argument is required and identifies the target field. The parent_fieldname can restrict the search to fields under a specific parent field. Outputs a multi-document YAML description where each document contains a field named fieldname values with the list of all values associated with the specified field. |