Appearance
AIOTIC MCP server
AI-assisted integration
@aiotic/mcp is a Model Context Protocol server that gives your coding assistant precise access to this guide and the API contracts — and, if you opt in on your own machine, to your test tenant.
Rendering diagram…
Docs mode is public and read-only. Tenant mode is local-only and off by default.
Docs mode (default)
No keys, no tenant. The server ships with an index of the guide and the OpenAPI document.
| Tool | What it returns |
|---|---|
search_guide(query, limit?) | Best-matching sections with page, heading and snippet |
get_page(path) | One page as Markdown (/receiving/erp-receive-endpoint) |
list_endpoints(tag?) | Method, path, summary, auth per endpoint (+ the outbound webhooks) |
get_endpoint(operationId | "METHOD /path") | Full contract: parameters, request/response schemas, examples |
get_schema(name) | One schema from the OpenAPI components (PurchaseOrder, ErpReceiveRequest, …) |
get_example(name) | Payload samples (erp-receive-request, order-status, sync-events) |
get_status_lifecycle() | Status values, meanings, transitions, sendable set |
Install:
json
{ "mcpServers": { "aiotic": { "command": "npx", "args": ["-y", "@aiotic/mcp"] } } }json
{ "servers": { "aiotic": { "type": "stdio", "command": "npx", "args": ["-y", "@aiotic/mcp"] } } }json
{ "mcpServers": { "aiotic": { "type": "http", "url": "https://developers.aiotic.ai/mcp" } } }The hosted endpoint runs the same server in docs mode only — stateless, rate-limited, no tenant tools, no secrets.
Tenant mode (opt-in, local only)
Lets the assistant look at your test tenant or the mock while you develop: "why is order X in ATTENTION?", "do we have product 620206_01 in AIOTIC?".
json
{ "mcpServers": { "aiotic": {
"command": "npx", "args": ["-y", "@aiotic/mcp"],
"env": { "AIOTIC_BASE_URL": "http://localhost:8080", "AIOTIC_API_KEY": "mock-integration-key" } } } }| Tool | Default |
|---|---|
tenant_health, get_order_status, list_orders, get_order_group, list_rejected_emails, get_customer, search_customers, list_products, get_product, list_customer_products | on (read-only) |
upsert_customer, upsert_product, upsert_customer_product, upload_order, retry_order, reprocess_rejected_email | off — AIOTIC_MCP_ALLOW_WRITES=true |
delete_*, send_order_to_erp | off — additionally AIOTIC_MCP_ALLOW_DANGEROUS=true and confirm: true in the call |
Rules the server enforces:
- Tenant tools exist only on the
stdiotransport. The HTTP transport refuses to start with a tenant configured. - Keys come from environment variables, never from tool arguments, and are never included in any output or log line.
- Every argument is schema-validated; responses are truncated to a bounded size; API responses are returned as data (the server never follows instructions found in them).
- Nothing is cached across sessions; nothing is written to disk.
Use a test tenant
Point tenant mode at the mock or a test tenant. A production key in an assistant's environment is a production key in an assistant's environment.
Versions
The package embeds the guide index and the API document of the guide version it was published with, so what your assistant reads is exactly one published edition. npx -y @aiotic/mcp always fetches the latest; pin a version with npx -y @aiotic/mcp@1.0.0 when you want reproducible answers. The version is reported to your MCP client on connect.