The EZ Suite MCP servers

Each EZ Suite product below includes its own MCP server. The AI works in the product you have open, with your Notes ID and the access it gives you, on the database or server loaded in the product. You do not need to know the tool names: ask for the result you want, and the AI picks the tools. They are listed here so you recognize them when your AI client asks you to allow one.

Products and addresses

Product

Default address

Entry in your AI client

Tools

aclEZ

http://localhost:33380/aclez/

mcp-aclez

11

actionBarEZ

http://localhost:33380/actionez/

mcp-actionez

12

agentEZ

http://localhost:33380/agentez/

mcp-agentez

11

consoleEZ

http://localhost:33380/consoleez/

mcp-consoleez

11

databaseEZ

http://localhost:33380/databaseez/

mcp-databaseez

11

designPropEZ

http://localhost:33380/designpropez/

mcp-designpropez

12

replicationEZ

http://localhost:33380/replicationez/

mcp-replicationez

11

scanEZ

http://localhost:33380/scanez/

mcp-scanez

27

signEZ

http://localhost:33380/signez/

mcp-signez

11

viewEZ

http://localhost:33380/viewez/

mcp-viewez

12

Tool counts are with no restriction set: Forbid reading data with AI hides get_selected_rows, and in scanEZ, Forbid saving data with AI hides the eight tools that change or export the ACL or switch Record activity.

Open the AI Settings panel of each product from HELP > AI SETTINGS... to start its server and configure your AI clients. See Install and connect an AI client. The server starts only with a license that includes the AI (MCP) feature: see Start server says the feature needs an AI (MCP) license.

In every EZ Suite product

Area

What you can ask

Tools used

Know where you stand

Which Notes ID and Notes client version am I using? Do I have Full Access Administration?

get_current_Notes_session
<product>_get_started, such as scanez_get_started (every product but signEZ)

Recent items and favorites

Which databases did I open recently? Add this database to my favorites.

list_recent_items
add_favorite

Read and analyze grids

How is this grid set up? How many rows are selected? Summarize the selected entries.

list_grids
get_grid_state
get_selected_rows

Select matching rows

Select the entries that end with /Acme. How many rows mention Manager?

select_matching_rows

Export to Excel

Export this grid to C:\Reports\acl.xlsx and open it.

get_grid_state (export option)

Work with automation scripts

Write and run an automation script that does this task. Save it as C:\Scripts\cleanup.xml.

runAutomation

Explain a failure

Why did my last automation script fail?

get_trace

Database products: actionBarEZ, designPropEZ, scanEZ, signEZ, viewEZ

What you can ask

Tools used

Which database is open?

get_current_database

What access do I have in this database? What access does Jane Doe/Acme have? Through which ACL entry, with which roles and privileges?

get_effective_access

Server products: aclEZ, agentEZ, consoleEZ, databaseEZ, replicationEZ

What you can ask

Tools used

Which server is loaded, how many databases does it show, which other servers are loaded? In aclEZ, agentEZ, databaseEZ and replicationEZ: is the database list complete, how old is it, how many databases are selected?

get_current_server

scanEZ

On top of the database tools, scanEZ gives the AI its tree, its database panel and its ACL panel.

Area

What you can ask

Tools used

Tree

Which categories are loaded, how old are they, how many notes do they hold? Which notes are checked? What does the Info tab of the focused note show?

get_tree_selection
get_focused_note

Database panel

Show me the database properties: template, inheritance, categories, document count, access, encryption, replica and database IDs, consistent ACL, transaction logging, and size if I ask. Open the replication history or the user activity. Turn Record activity on.

get_database_properties
open_replication_history
open_user_activity
set_record_activity

ACL panel

Show me the ACL and its history. Add, rename or remove a role, then save. Copy this ACL to another database. Export the ACL to a DXL file.

show_acl_panel
open_acl_history
add_acl_role, rename_acl_role, remove_acl_role
save_acl
import_acl, export_acl
export_acl_dxl

  • Role changes stay pending in the ACL panel until they are saved, as they do when you edit by hand. A role name holds 15 characters at most.

  • Copying an ACL to or from another database replaces that ACL and saves it at once.

  • The replication history and user activity windows open once the AI has answered; the AI can then read their grids.

  • Asking for the database size can be slow on a large server database.

Actions that need your go-ahead

Every tool that changes something requires the AI to state that you asked for it: adding a favorite, turning Record activity on or off, every ACL change, saving the ACL, copying or exporting an ACL. Two of them also require your explicit confirmation of what will be lost: switching Record activity off, and replacing an ACL.

Important: the AI states your go-ahead itself, from what you wrote in the conversation. Keep your AI client's approval prompt on for these tools, so that you see and accept each change before it runs.

Reading data

  • The AI reads the rows you selected directly from the grid, with typed values, under the column titles the grid shows, and can ask for only the columns it needs. It reads up to 200 rows by default and 2,000 at most; for more, ask for an export.

  • The AI works with every grid open in the product, the main grid included. It can select the rows that match a pattern, in every visible column or in the columns it picks, as Find All (Ctrl+F3) does: the matching rows replace your current selection, and the AI learns how many there are. It changes the selection only, never the data.

  • The product tells the AI when the data of a grid or of the database list is not fully loaded, or is older than 30 minutes; the AI then tells you and can suggest loading it again.

  • With Forbid reading data with AI, no grid content reaches the AI: it cannot read selected rows or export, and trace lines are masked. It can still select the rows that match a pattern and count them. See Security, restrictions and your data for what the other tools still report.

Automation scripts

  • The AI runs automation scripts in the product with runAutomation, one at a time: while an automation script is running, the product answers that a job is already running. The AI is told to look up the action tags and attributes in the Ytria automation documentation before writing an automation script.

  • When you ask, the AI saves the automation script to a file, even if it failed, so you can fix and run it again. A file name without a folder lands in the product's own folder under %LOCALAPPDATA%.

  • With Forbid saving data with AI, a Save action in an automation script run by AI ends in error and stops the automation script; the changes stay pending, for you to review and save.

  • With Forbid switch ID with AI, a SwitchID action in an automation script run by AI ends in error and stops the automation script: the AI keeps working with the user ID already loaded.

  • A run started by AI is marked AI - in the automation console.

Lite mode

In lite mode, the AI cannot change an ACL, switch Record activity, export an ACL to DXL, or add favorites in the server products and consoleEZ; list_recent_items lists your favorites only.

Getting good answers

When your AI client connects, every product but signEZ briefs the AI on what the product is, and tells it to take the shortest way to do a task: a tool that does it directly, then an automation script you already have, and only then a new automation script. Before anything else, the AI calls the product's get_started tool, such as scanez_get_started. This tool reports what the product holds (your Notes session, the database or server loaded), which restrictions are set, and the rules for this product. For example, in aclEZ the AI says which entries of which databases will change before it applies ACL changes, and in consoleEZ it never sends a console command: it gives you the command and the servers to send it to. The full set of rules is in How the AI carries out a task.

In every product, each tool also tells the AI what it does and what it needs. Say which database or server your request is about, and for an automation script, ask the AI to check the Ytria automation documentation and to test it on a small selection first.

Prompts to try

  • “Which Notes ID is scanEZ using, and do I have Full Access Administration?”

  • “Which database is open in scanEZ, and what access does Jane Doe/Acme have in it?”

  • “Which categories are loaded in the scanEZ tree, and how old are they?”

  • “Show me the ACL of this database and its history.”

  • “How many databases are selected in databaseEZ, and is the list complete?”

  • “Export this grid to C:\Reports\acl.xlsx and open it.”

  • “Why did my last automation script fail?”