Nexa API · v1

Developers

Nexa

AI assistants

Connect an AI assistant

Nexa runs a Model Context Protocol (MCP) server. Add it to the assistant you already use — Claude, ChatGPT, Cursor, VS Code — sign in with your Nexa account, and ask about your operations, machines and maintenance plans in plain words. It can act on them too, if you allow it.

Before you start

  • Your business needs the Essential plan or higher. On Standard, the business shows as unavailable when you approve the connection. That is a plan change, not a setup problem.
  • Each person connects their own assistant. There is no shared key and nothing for an administrator to configure. The assistant signs in as you and can do exactly what your role allows — nothing more. A technician’s assistant sees what a technician sees.
  • One business per connection. When you approve, you choose which business the assistant may use and whether it may change anything. To use two businesses, connect twice.

The server URL

Every client below asks for the same address:

MCP server
https://nexa.com.tn/api/mcp

You can also copy it from the Nexa portal, at Settings → Integrations → AI assistants (MCP), which also lists the assistants already connected.

The first time the assistant connects, it opens a Nexa page in your browser. Sign in if you are not already, choose the business and the access level, and approve. You are sent back to the assistant, which is now connected.

claude.ai and Claude Desktop

  1. Open Settings → Connectors.
  2. Choose Add custom connector, name it Nexa and paste https://nexa.com.tn/api/mcp as the URL. Leave the advanced OAuth fields empty: Claude registers itself with Nexa.
  3. Select Connect. A Nexa window opens; approve the connection there.
  4. In a conversation, turn the Nexa connector on from the tools menu and ask away: “What is overdue this week?”

A connector added on claude.ai is also available in Claude Desktop when you sign in with the same account. On a Claude Team or Enterprise plan, an owner of your Claude organisation may need to add the connector first.

Claude Code

Terminal
claude mcp add --transport http nexa https://nexa.com.tn/api/mcp

Then start Claude Code, run /mcp, pick nexa and choose Authenticate. Your browser opens the Nexa approval page. Add --scope user to the command to make the server available in every project, not just the current one.

ChatGPT

ChatGPT adds custom MCP servers through developer mode, which depends on your ChatGPT plan and, in a workspace, on what its admin allows.

  1. In Settings → Apps & Connectors → Advanced settings, turn on Developer mode.
  2. Back in Apps & Connectors, choose Create. Name it Nexa, paste https://nexa.com.tn/api/mcp and choose OAuth as the authentication.
  3. Approve the connection on the Nexa page that opens.
  4. In a chat, enable the Nexa connector from the tools menu. ChatGPT asks for your confirmation before every action that changes data.

Cursor and VS Code

Both read an mcp.json file. Add Nexa to it and the editor prompts you to sign in the first time a tool is used.

{
  "mcpServers": {
    "nexa": {
      "url": "https://nexa.com.tn/api/mcp"
    }
  }
}

In Cursor, the file can also live in a project at .cursor/mcp.json. In VS Code, the server’s tools appear in Copilot Chat’s agent mode.

Other clients

Any client that speaks MCP over Streamable HTTP with OAuth 2.1 works. Nexa supports dynamic client registration and PKCE (S256), so there is no client ID to request. A client discovers the rest from the server URL: an unauthenticated call answers 401 with a WWW-Authenticate header pointing at the protected resource metadata.

Discovery
https://nexa.com.tn/.well-known/oauth-protected-resource/api/mcp
https://nexa.com.tn/.well-known/oauth-authorization-server/api

Read only or read & write

You choose one when you approve the connection.

AccessWhat the assistant can do
Read onlyLook things up, summarise, compare and explain. Every tool that changes data is hidden from it, and Nexa refuses a change even if one is attempted.
Read & writeAlso create and update — open an operation, assign a technician, log downtime, reserve parts — within your role. Claude asks you before any change is made.

If your role in a business can only view, read & write is not offered for it. Everything the assistant changes is recorded in the business’s audit log under your name, marked as made through the assistant.

What the assistant can do

The server has 94 tools, in toolsets. An assistant only ever sees the tools it may use: those your role allows, those your plan includes, and on a read-only connection, only the reads. Every tool that changes data is marked as one, so Claude asks you before any change is made.

ToolsetReadsChanges
Discovery3 toolsSearch across everything, fetch any record by id or link, a business overview.—
Operations12 toolsOperations with filters; one operation with, on request, its history, comments, procedures and part demands; problem reports.Create, update, assign to a technician or vendor, reschedule, cancel, change status, comment.
Assets & plants20 toolsAssets and machines, with their children and documents on request; expiring documents, failure history and failure codes; buildings, plants, rooms and plant plans.Create, update, move, install, change the status of or delete assets; create and update buildings, floors and rooms.
Downtime5 toolsDowntime events and the summary by cause.Log and close downtime, set the stop cause.
Preventive maintenance & procedures10 toolsPM plans, the maintenance calendar, procedures and their submissions.Create, preview, update and cancel PM plans.
Spare parts & purchasing12 toolsStock, movements, reservations, stock adjustments, suppliers, purchase orders.Adjust stock, approve or reject adjustments, reserve parts for an operation, create or cancel purchase orders.
Team6 toolsTechnicians and their workload, shifts, vendors, team members.—
Telemetry & predictive6 tools · Enterprise (machine telemetry)Live machine signals and history, alarms, machine health, failure predictions, condition rules.—
Automations, reports & messages12 toolsAutomation flows and their runs, reports, notifications, conversations.Run a manual flow, generate a report, mark notifications read, send a message.
Nexa AI8 toolsDiagnose a fault and collect the result, past diagnoses, recommend a technician, search the maintenance knowledge base, an asset's maintenance summary, analyse a machine, and maintenance recommendations.Accept or dismiss a maintenance recommendation.

Every tool, by name

The names your assistant shows when it asks to use one. Some tools take a mode rather than coming in variants: get_operation and get_asset add related records on request, and the decide_* tools approve or reject.

Discovery
searchfetchget_business_overview
Operations
list_operationsget_operationget_operation_filter_optionslist_problem_reportscreate_operationupdate_operationassign_operationassign_operation_to_vendorreschedule_operationcancel_operationoverride_operation_statuscomment_on_operation
Assets & plants
list_assetsget_assetlist_expiring_asset_documentsget_asset_failure_historylist_failure_codescreate_assetupdate_assetset_asset_statusmove_assetinstall_assetdelete_assetlist_buildingsget_building_hierarchyget_plant_planlist_roomscreate_buildingupdate_buildingcreate_floorcreate_roomupdate_room
Downtime
list_downtime_eventsget_downtime_summarylog_downtime_eventclose_downtime_eventset_downtime_cause
Preventive maintenance & procedures
list_pm_plansget_pm_planget_maintenance_calendarcreate_pm_planpreview_pm_planupdate_pm_plancancel_pm_planlist_proceduresget_procedureget_procedure_submission
Spare parts & purchasing
list_spare_partsget_spare_partlist_stock_movementslist_part_reservationsadjust_stocklist_stock_adjustmentsdecide_stock_adjustmentreserve_parts_for_operationlist_purchase_orderslist_supplierscreate_purchase_ordercancel_purchase_order
Team
list_techniciansget_technicianget_technician_workloadlist_shiftslist_vendorslist_team_members
Telemetry & predictive
get_machine_signalsget_signal_historylist_machine_alarmsget_machine_healthget_machine_predictionslist_condition_rules
Automations, reports & messages
list_flowsget_flowlist_flow_runslist_runnable_flowsrun_flowgenerate_reportlist_reportslist_notificationsmark_notifications_readlist_conversationsget_conversation_messagessend_message
Nexa AI
diagnose_faultlist_diagnosesrecommend_techniciansearch_maintenance_knowledgeget_asset_maintenance_summaryanalyse_machinelist_maintenance_recommendationsdecide_maintenance_recommendation

Ready-made prompts

Clients that support MCP prompts (Claude shows them as slash commands) also get these:

  • morning_brief — overdue and today's work, open breakdowns, machine alarms and low stock, in one page.
  • triage_breakdown — from a machine and a symptom: diagnose, find a technician, raise and assign the operation, reserve parts.
  • plan_next_week — balance next week's preventive and corrective work across the team.
  • weekly_report — what was done last week, how fast, and what keeps failing.
  • reorder_check — parts below minimum, parts needed by upcoming work, and a draft purchase list.

Things to ask

Ask in your own words, in English, French or Arabic. A few that work well:

  • “What maintenance is overdue this week, and who is it assigned to?”
  • “Which machines had the most downtime last month, and why?”
  • “Line 2’s filler is leaking at the nozzle. What could it be, and who is free to look at it tomorrow?”
  • “Create a high-priority corrective operation for the bottle rinser and assign it to the best available technician.”
  • “Which spare parts are below their minimum stock, and which upcoming jobs need them?”
  • “Plan next week’s preventive maintenance so nobody is overloaded.”
  • “Summarise last week’s maintenance for my manager.”

On a read & write connection, Claude shows you each change and asks before making it. Changes appear in Nexa straight away and in the business’s audit log, marked with the assistant’s name.

What it can never do

Some things stay in the Nexa portal, done by a person, whatever the access level and whatever the role:

  • change your password, email, two-factor or sessions;
  • change billing or the plan;
  • see or change finance: budgets, expenses, revenues and costs;
  • invite people, or change team roles and permissions;
  • create API keys or configure integrations;
  • delete the business.

Disconnecting

In the Nexa portal, open Settings → Integrations → AI assistants (MCP) and select Revoke next to the connection. Its next request is refused and the assistant asks you to sign in again. A business owner sees and can revoke every member’s connections; everyone else sees their own. Connections also appear under Settings → Security as “AI assistant”.

Changing your password ends every connection too, and a connection stops working as soon as you leave the business.

Your data

  • What the assistant receives: only the answers to the requests it makes, limited to the business you chose and to what your role can see. It never receives your password; Nexa gives it its own token, which you can revoke.
  • What Nexa keeps: the connection itself (assistant name, business, access level, when it was created and last used, IP address and browser), and, for every change the assistant makes, an audit-log entry marked with its name. Nexa does not receive or store your conversation with the assistant.
  • The assistant’s side: what you and the assistant say, and the Nexa data it reads, are handled by the assistant’s provider (Anthropic, OpenAI…) under their own terms and privacy policy.
  • How long: a connection ends when you revoke it, when you change your password or leave the business, after 90 days without use, and at the latest one year after you connected.

The full details are in the privacy policy.

Troubleshooting

The assistant says…What it means
Your plan doesn’t include thisThe business is on a plan without AI assistants, or without the feature behind that tool (telemetry, for example). Ask the owner about upgrading.
Your role can’t do thisYour role in the business lacks that permission. The assistant is not the problem: you could not do it in the portal either.
The connection is read-onlyYou approved read only. Revoke the connection and connect again with read & write.
Sign in again / authorization expiredThe connection was revoked, expired, or ended by a password change. Reconnect from the assistant.
The approval page says the request expiredAn approval page is valid for 15 minutes. Start the connection again from the assistant.

Building your own integration rather than chatting? The REST API is the better fit for system-to-system sync.

Support

Something not working, or a question about what the assistant can do? Write to contact@nexa.com.tn with the assistant you use and, if you have it, the time of the failed request. Security issues: use the same address with “Security” in the subject.

On this page