MCP server
Notory ships an MCP server (Model Context Protocol). It lets any AI assistant that supports MCP talk to your Notory instance: the assistant can read your inventory and - with the right token - maintain it, by calling the Notory REST API under the hood. The server is client-neutral; it does not matter which MCP-capable app you use.
What the assistant can do
Section titled “What the assistant can do”The server exposes these tools:
| Tool | Purpose |
|---|---|
notory_list_endpoints | List the available API endpoints from the live OpenAPI spec (optionally filtered). |
notory_get | Read any endpoint (GET only). |
notory_request | Call any endpoint with any method (writes need a write scope). |
notory_list_assets | List assets with filters and pagination. |
notory_get_asset | Fetch a single asset by id. |
Because notory_list_endpoints and notory_request together cover the whole
API (200+ endpoints), the assistant can work with assets, network, software,
licenses, certificates, compliance and more - not just the convenience tools.
Prerequisites
Section titled “Prerequisites”- Node.js 18+ on the machine that runs the assistant.
- A Notory API token. Create one in the web UI under Settings → API
tokens (see API tokens). It is shown once,
in clear text, and starts with
inv_. Use thereadscope to keep the assistant read-only, orwriteto allow changes.
1. Get and build the server:
# from the Notory MCP repositorynpm installnpm run build2. Register the server with your MCP client. Almost every MCP-capable client
reads a JSON config with an mcpServers section. Add the server there (adjust the
path, base URL and token):
{ "mcpServers": { "notory": { "command": "node", "args": ["/absolute/path/to/notory_mcp/dist/index.js"], "env": { "NOTORY_BASE_URL": "https://demo.notory.io", "NOTORY_API_TOKEN": "inv_your_token_here" } } }}Where exactly this config lives depends on the client (usually a JSON file in its
settings). The launch command is always the same: node .../dist/index.js with
the two environment variables.
3. Restart the client. You can then ask things like “list the assets in maintenance” or “show asset SN-001”.
Configuration
Section titled “Configuration”| Variable | Required | Description |
|---|---|---|
NOTORY_BASE_URL | yes | Instance base URL, e.g. https://demo.notory.io (no trailing /api). |
NOTORY_API_TOKEN | yes | Notory API token (inv_...). The scope decides read-only vs read/write. |
Good to know
Section titled “Good to know”- Prefer a
readtoken unless the assistant genuinely needs to write. - The server is a thin, stateless proxy over HTTPS - nothing is stored.
- The machine-readable spec is at OpenAPI spec (JSON); the searchable reference is at API reference.
Related
Section titled “Related”- API getting started - authentication, base URL, error codes.
- Manage API tokens - create and revoke tokens.