Versions Compared

Old Version 2

changes.mady.by.user Sameer Sharma

Saved on

compared with

New Version 3

changes.mady.by.user Sameer Sharma

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section

Backend Configuration (Admin side)


Panel


FieldDescription
Enable MCP Server

This setting controls whether the MCP Server is active for the selected store view. When enabled,

supported AI clients can connect to the store and interact with the available MCP features. When

disabled, external AI connections through the MCP endpoint are blocked and the server will not

respond to client requests. Default value: Yes.


Panel


FieldDescription
Allowed IP Addresses

Specify the IP addresses that are permitted to access the MCP Server. Add one IP address per

line to restrict access only to trusted sources. If this field is left empty, the MCP Server will

accept requests from all IP addresses.


Panel


FieldDescription
Access Token Lifetime (seconds)

Defines how long an issued access token remains valid before a new one must be obtained

through the refresh flow. A shorter duration improves security, while a longer duration

reduces the need for frequent token refresh requests.

Refresh Token Lifetime (seconds)

Specifies how long the connection can stay authorized without requiring the user to approve

access again. Once this period ends, the client must complete the authorization process again

to continue using the server.

Require User Consent

Determines whether users must explicitly approve access when an AI client attempts to connect.

When enabled, a consent screen is shown before authorization is granted.

Enable Personal Access Tokens

Allows users to generate static bearer tokens for clients or tools that do not support OAuth-based

authentication. This option is useful for external integrations that require direct token-based access.

Personal Token Lifetime (seconds)

Sets the validity period for generated personal access tokens. Enter 0 to keep the token active

without expiration, or specify a duration in seconds to enforce automatic expiry.


Panel


FieldDescription
Query Timeout (seconds)

Defines the maximum time allowed for a database query to run. If a query exceeds this limit,

it is stopped automatically to help maintain performance and prevent long-running

requests from affecting the system.

Table Access Mode

Controls how database table rules are applied. Whitelist allows access only to the tables that

are explicitly listed, while Blacklist blocks the listed tables and keeps all other tables accessible.

Table Patterns

Use this field to define which tables should be allowed or blocked based on the selected access

mode. Add one pattern per line, and use * as a wildcard to match multiple tables,

such as sales_* or customer_*.

Auto-limit

Sets the default row limit for SELECT queries that do not already contain a LIMIT clause. This

helps avoid returning very large result sets and keeps query responses more efficient.

Include Default Security Blacklist

Enables the built-in protected table rules that automatically block access to sensitive database

areas, such as tables containing credentials, tokens, sessions, and other restricted data.

Default Blacklist Patterns (read-only)

Displays the predefined restricted table patterns used by the default security blacklist. This field

is for reference only and helps administrators understand which sensitive tables are protected by default.


Panel


FieldDescription
Enable Request Logging

Enables logging of MCP requests for monitoring and troubleshooting purposes. When

enabled, the system records request activity so administrators can review interactions made

through the MCP Server.

Log Level

Defines how much request information is stored in the logs. Basic records key request details,

Detailed stores additional request arguments, and Debug captures the most complete

response-level information for deeper analysis.

Log Retention (Days)

Specifies how long log records should be kept before cleanup. Set the number of days based

on your monitoring needs, or use 0 to retain logs without automatic expiration.



panel
  • is intended for standard user profile management such as login details, contact information, password updates, locale preference, and account validity. 
Section

Backend Functionality

MCP Users

Panel

Image Added

  • The MCP Users grid is the central admin section for viewing and managing users who have access to the MCP Server. It gives administrators a quick overview of user access status, connected client types, and usage activity in one place. From this grid, admins can also take direct actions to review user connection details or open the user profile for further management.
FieldDescription
IDDisplays the unique record identifier for each MCP user entry.
UserShows the admin username associated with the MCP access record.
Access Status

Indicates whether MCP access is currently enabled or disabled for the user. This helps

administrators quickly identify which users are allowed to connect.

Clients

Displays the connected client type associated with the user, such as a Personal Access

Token or other authorized client connection.

Added to MCPShows the date and time when the user was first added to the MCP system.
Last Used

Displays the most recent date and time the user or connected client interacted with

the MCP Server.

Action

Provides row-level management options for the selected user, such as viewing connection

details or opening the related user record for further changes.

Actions

The top-left mass action control allows administrators to apply bulk operations to

selected user records.

Records FoundDisplays the total number of MCP user records currently available in the grid.
Per PageLets administrators control how many records are shown in the grid at one time.
Pagination

Allows navigation across multiple pages when the number of MCP users exceeds

the selected per-page limit.

User Details

Panel

Image Added

  • When the Details option is selected from the Action column in the MCP Users grid, a token details popup is opened for the selected user. This popup allows administrators to review all token records linked to that user, including their current status and creation date. It also provides a direct option to revoke an active token when required.
FieldDescription
MCP Token Details

Displays a popup window containing the token history and status details for

the selected MCP user.

Token IDShows the unique identifier assigned to each token record.
StatusIndicates the current state of the token, such as Active or Revoked.
Created AtDisplays the date and time when the token was generated.
ActionProvides token-level management actions for the selected record.
Revoke

Allows administrators to manually revoke an active token to immediately

disable its usage.

CloseCloses the popup window and returns to the MCP Users grid.

Edit User

Panel

Image Added

  • The Edit User screen opens when the administrator selects Edit User from the Action column in the MCP Users grid. This section is used to manage MCP access for a specific admin user and review authentication-related details linked to that user. It also allows the administrator to update the access status, view client credentials, and save changes directly from the user profile.
FieldDescription
MCP AccessDisplays the MCP-related settings section for the selected admin user.
MCP Access Status

Allows the administrator to enable or disable MCP access for the user. When disabled, the

user will not be able to authenticate through OAuth or use MCP tools.

Client ID

Shows the unique client identifier assigned to the selected user for MCP authentication.

This value can be used for manual OAuth token generation.

Client Secret

Displays the secret key linked to the selected MCP client. It is masked by default for

security purposes.

ShowReveals the hidden client secret so the administrator can review it when needed.
Save UserSaves all changes made to the selected user profile.
BackReturns to the previous screen without making further changes.
Delete UserRemoves the selected admin user from the system.
ResetDiscards unsaved changes and restores the current form values.
Force Sign-InForces the selected user to sign in again for security or session control purposes.
MCP InfoOpens the MCP-specific configuration tab for the selected admin user.
User InfoOpens the general account information section for the selected user.
User Role

Opens the role assignment section where the administrator can manage

permissions for the selected user.


Panel

Image Added

  • The OAuth Connections Summary section under MCP Info gives administrators a quick overview of the selected user’s MCP connection activity. It shows how many clients are connected, the current token status, when the user was added to MCP, and the latest usage activity. This section also provides direct actions to review token details or revoke all active tokens for that user.
FieldDescription
Connected ClientsDisplays the total number of AI clients currently connected for the selected user.
Active TokensShows the number of currently valid and usable tokens linked to the user.
Expired/Revoked Tokens

Displays the total number of tokens that are no longer active due to expiration or

manual revocation.

Added to MCPShows the date and time when the user was first added to the MCP system.
Last Tool Used

Displays the most recent MCP tool usage activity for the selected user. If no action

has been performed yet, it shows Never.

Show Details

Opens the detailed token view for the selected user, where token-level records can

be reviewed.

Revoke All Tokens

Revokes all active tokens associated with the selected user to immediately disable

existing MCP connections.


Panel

Image Added

  • When the Show Details button is clicked in the OAuth Connections Summary section, a Token Details popup opens for the selected user. This popup provides a record-wise view of all connected MCP clients and their token information, helping administrators review token validity, expiry, and status from one place. It also allows direct revocation of an active token when required.
FieldDescription
Client

Displays the type or name of the connected client associated with the token, such as

a Personal Access Token.

Client CodeShows the unique code assigned to the connected client for identification purposes.
Created AtDisplays the date and time when the token was created.
Expires AtShows the date and time when the token will expire and become unusable.
StatusIndicates the current condition of the token, such as Active or Revoked.
ActionProvides token-level actions for the selected client record.
RevokeAllows administrators to immediately deactivate the selected active token.
CloseCloses the popup window and returns to the previous screen.
Records FoundDisplays the total number of token records shown in the popup.
Per PageAllows administrators to choose how many token records are displayed per page.
PaginationHelps navigate between multiple pages if more token records are available.


Panel

Image Added

  • The AI Client Configuration section under MCP Info provides ready-to-use connection instructions for supported AI clients in a tab-based layout. It helps administrators quickly connect an AI client by using prefilled server details, one-step setup commands, and manual configuration snippets. This makes the client onboarding process simpler and reduces the chance of configuration errors.
FieldDescription
AI Client Configuration

Displays client-specific connection instructions for integrating supported AI tools

with the MCP Server.

Claude Code

Shows setup instructions for connecting the store with Claude Code using

command-line configuration.

Claude Desktop/WebProvides guided connection details for Claude Desktop and Claude Web clients.
Gemini CLI

Displays setup instructions for connecting the store with the Gemini command-line

client.

OpenAI Codex

Provides connection details for configuring the OpenAI Codex client with the MCP

Server.

OpenAI ChatGPT

Shows setup instructions for connecting ChatGPT through the supported app-based

MCP flow.

Other

Provides generic MCP connection details for other compatible AI clients. It can also

be used for clients that require alternative connection handling.

Prerequisites

Lists any required tools, packages, or conditions that must be completed before

configuring the selected AI client.

MCP Server URL

Displays the prefilled MCP endpoint URL for the current store, which is used

during client setup.

OAuth Authorization URLShows the authorization endpoint required for authenticated client connection.
Quick Setup Command

Provides a ready-to-copy command that allows the selected client to be

configured in a single step.

Manual Setup Configuration

Displays the configuration snippet or structured setup block that can be added

manually to the client configuration file.

CopyCopies the related command, URL, or configuration block for faster setup.
Documentation Link

Opens the related client documentation for additional reference or

advanced setup guidance.


Panel

Image Added

  • The User Info tab is part of the admin user edit screen and is used to manage the selected user’s general account details. Unlike the MCP Info tab, which focuses on MCP access and connection settings, this section

Frontend Functionality

Panel
Panel
Panel
Panel
FieldDescription
User Name

Specifies the login username for the admin user account. This value is used when the

user signs in to the admin panel.

First NameDefines the first name of the admin user for identification within the system.
Last NameDefines the last name of the admin user for profile and record display purposes.
Email

Stores the email address associated with the admin user account. This is used for

account-related communication and identification.

New PasswordAllows the administrator to assign a new password for the selected user account.
Password ConfirmationConfirms the new password entry to avoid accidental password mismatches.
Interface Locale

Lets the administrator choose the language or locale used in the admin interface

for the selected user.

Expiration Date

Sets the date until which the admin user account remains active. After this date, the

account can be restricted based on system behavior.

Your Password

Requires the current administrator password to verify identity before saving

sensitive account changes.

Save UserSaves all updates made in the User Info tab.
BackReturns to the previous screen without continuing further actions.
Delete UserRemoves the selected admin user account from the system.
ResetDiscards unsaved changes and restores the current form values.
Force Sign-In

Forces the selected user to sign in again, which is useful for session control or security

purposes.

MCP InfoOpens the MCP-specific settings tab for the selected user.
User InfoOpens the general account information tab for the selected user.
User Role

Opens the role assignment tab where permissions and access levels can be managed

for the selected user.


Panel

Image Added

  • The User Role tab in the Edit User section is used to assign or change the admin role for the selected user. It helps control what areas, tools, and permissions the user can access in the admin panel, including MCP-related capabilities based on the assigned role. This tab also includes basic grid controls to search and filter available roles before selecting one. 
FieldDescription
Assigned

Lets the administrator choose whether a role is assigned to the selected user. The radio

option is used to select one role from the available list.

RoleDisplays the list of available admin roles that can be assigned to the user.
SearchApplies the selected filters and updates the role list accordingly.
Reset FilterClears the applied filters and restores the default role listing.
Records FoundShows the total number of role records currently available in the grid.
Per PageLets the administrator define how many role records should be displayed per page.
Pagination

Enables navigation between pages when more role records are available than the selected

page limit.

Save UserSaves the selected role assignment and any related changes made for the user.
BackReturns to the previous screen.
Delete UserDeletes the selected admin user account.
ResetDiscards unsaved changes made on the current edit screen.
Force Sign-InForces the selected user to sign in again for security or session control purposes.
MCP InfoOpens the MCP-specific settings tab for the selected user.
User InfoOpens the general account information tab for the selected user.
User RoleOpens the role assignment tab where the user’s admin role can be selected or updated.

Role-Based MCP Access Configuration

Panel

Image Added

  • The MCP Info tab under System → Permissions → User Roles is used to manage MCP-related access rules at the role level. It lets administrators define how the Database Reader should behave for users assigned to that role and also provides a quick view of the MCP tools available to the role. This helps apply tighter access control without changing the global MCP configuration for all users. 
FieldDescription
MCP InfoOpens the role-level MCP configuration section for the selected admin role.
Database Reader SecurityDisplays role-specific security controls for database access through MCP.
Access Mode

Defines how database table restrictions are applied for the selected role.

  • Use Global Settings follows the system-wide configuration,
  • Blacklist blocks only the listed table patterns,
  • Whitelist allows access only to the listed table patterns.
Table Patterns

Lets administrators enter table name patterns to control database access for

the role. Add one pattern per line and use * as a wildcard,

such as sales_* or customer_entity.

Store Info

Shows the MCP tool access view for store configuration and store structure

information available to this role.

GraphQL Query

Shows the MCP tool access view for GraphQL query capability available to

this role.

Database Reader

Shows the MCP tool access view for database query access available to this

role.

MCP Tools View

Displays the MCP tools assigned to the role, helping administrators quickly

review what functionality is available under that role.

Save RoleSaves the MCP role settings and any other updates made to the selected role.
BackReturns to the previous role management screen.
Delete RoleRemoves the selected role from the system.
ResetDiscards unsaved changes and restores the current form values.
Role InfoOpens the general role information tab.
Role Resources

Opens the permissions tree where Magento and MCP resources can be

assigned to the role.

Role UsersOpens the section showing users assigned to the selected role.


Panel



Panel



Panel




Section

Frontend Functionality


Panel




Note



Section

Demo

Click here to visit frontend.

Click here to visit backend admin panel.

...