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-connection-check | Retrieve the status of the connection to the Rest API server. |
zowe-list-all-profiles <type> | List all zowe profiles configured in the Zowe team configuration file by type, defaults to all profiles. |
zowe-login | Log in with the editor's set profile to obtain a JWT. |
zowe-logout | Log out from the server with the editor's set profile and remove the JWT from the team configuration file. |
You can manage data sets and members on z/OS® and run TSO commands.
| Tool Name | Tool Description |
|---|
zowe-get-datasets <filter> | Retrieve data sets that match the specified filter pattern. |
zowe-get-members <dataSetName> | List members of the specified data set. |
zowe-download-member <name> | Download the specified data set member. |
zowe-allocate-like-dataset <dataSetName> <existingDataSet> | Allocate a new specified data set similar to an existing one. |
zowe-issue-tso-command <command> | Execute the specified TSO command. |
You can manage files and folders on z/OS UNIX System Services and run UNIX commands.
| Tool Name | Tool Description |
|---|
zowe-get-unix-files <filePath> | List the UNIX System Services files in the specified path. |
zowe-put-unix-files <localPath> <unixPath> | Upload a local file to the specified location on UNIX System Services. |
zowe-create-unix-files <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-download-unix-file <unixPath> | Download the contents of the specified UNIX System Services file. |
zowe-issue-unix-command <unixCommand> | Execute the specified UNIX command on the system. |
You can get information about z/OS jobs and spool files.
| Tool Name | Tool Description |
|---|
zowe-get-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-job-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-job-jcl <jclString> | Submit a job for the given local JCL. |
zowe-get-job-spools <jobName> <jobId> | Retrieve the spools files for the specified job name and job ID. |
zowe-get-job-spool-output <jobName> <jobId> <spoolId> | Retrieve the output of a job spool, identified by job name, job ID, and spool ID. |
| Tool Name | Tool Description |
|---|
rseapi-get-system-resource-consumption | Run DISPLAYACTIVE to retrieve system address space resource consumption information. Only available 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. |
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, and both 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 | |
|---|
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. |
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. |
| 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 | Runs a COBOL code scan on the currently open and active program file. Use the results returned to provide a detailed summary of the problems found and suggest fixes based on COBOL best practices. If possible, include examples for how to fix the problems described. If errors are found, list the error code and message. |
zcodescan-check-list-of-local-programs <searchPatterns> | Runs a code scan program files in your local workspace and analyzes the results using COBOL best practices. If possible, include examples for how to fix the problems described. If errors are found, list the error code and message. |