-
Notifications
You must be signed in to change notification settings - Fork 2
Reference Generated MCP Tools System
Input schemas for the 10 system tools. The index of every module is in mcp-tools.md; a live server answers the same thing authoritatively through the tools/list JSON-RPC method.
Provision a new user via the invitation flow so it can be referenced as an owner / reviewer. No password is accepted: the account is created with an unusable password and the response returns an 'activation_url' the invitee follows to set their first credential. 'groups' are role / group names that must already exist (use list_groups). Requires the system.users.create permission.
Requires system.users.create.
| Parameter | Type | Required | Description |
|---|---|---|---|
email |
string |
yes | Email address (login identifier). Must be unique. |
last_name |
string |
yes | Last name (required). |
first_name |
string |
- | First name. |
user_type |
string |
- | Account type: 'human' (default) or 'robot' (service account). |
job_title |
string |
- | Job title. |
department |
string |
- | Department. |
phone |
string |
- | Phone number. |
language |
string |
- | Preferred UI language code, e.g. 'en' or 'fr'. |
groups |
array |
- | Role / group names to assign (must already exist). |
Get the company settings (name, application name, AI assistant name, address, accent colour, whether the company logo replaces the Cairn logo)
Requires system.config.read.
No parameters.
Get group details including permissions
Requires system.groups.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
Get detailed information about a user
Requires system.users.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string |
yes | UUID of the object |
List access logs (authentication events)
Requires system.audit_trail.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
event_type |
string |
- | Filter by event type |
user_id |
string |
- | Filter by user ID |
List user feedback on Ask Cairn answers (thumbs up/down and optional comment), with the original question, language and the LLM response. Read-only; for quality analysis. Feedback already marked corrected is excluded unless include_resolved=true.
Requires system.assistant_feedback.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
rating |
string |
- | Filter by rating: 'up' or 'down' |
language |
string |
- | Filter by interface language code |
provider |
string |
- | Filter by LLM provider |
user_id |
string |
- | Filter by user ID |
include_resolved |
boolean |
- | Include feedback already marked corrected (default false) |
List all groups
Requires system.groups.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
List all available permissions
Requires system.groups.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
module |
string |
- | Filter by module (context, assets, compliance, risks, system) |
List users with optional search
Requires system.users.read.
| Parameter | Type | Required | Description |
|---|---|---|---|
search |
string |
- | Text search query |
limit |
integer |
- | Max items to return (default 25, max 100) |
offset |
integer |
- | Offset for pagination |
is_active |
boolean |
- | Filter by active status |
Update company settings (name, application name, AI assistant name, address, accent colour, and/or whether the company logo replaces the Cairn logo)
Requires system.config.update.
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
- | Company name |
app_name |
string |
- | Custom application name shown in the sidebar and tab titles (defaults to Cairn when empty) |
assistant_name |
string |
- | Custom name for the AI assistant shown in the command palette, its answers and the sidebar (defaults to Ask Cairn when empty) |
address |
string |
- | Company address (multi-line) |
accent_color |
string |
- | Accent colour as a 6-digit hex code (e.g. #1E3A8A) used throughout the app; empty string resets to the Cairn navy |
use_logo_as_app_brand |
boolean |
- | When true, the company logo replaces the Cairn logo across the application (sidebar, page headers); the About dialog always keeps the Cairn logo. Requires a company logo to be set. |
Built from docs/ at v0.36.0. Edits made here are overwritten by the next release : open a pull request against the source instead.
- Administration
- Ask Cairn
- Assets and suppliers
- Compliance
- The dashboard
- Finding your way
- Getting started
- Incidents
- How records move
- Organisational context
- Reports and management review
- Risks
- Trust Center
- Architecture
- Configuration
- Contributing
- The documentation system
- Installation
- Internationalisation
- Operations
- Release process
- Security
- Testing
- Adding an assistant provider
- Adding a dashboard widget
- Adding a domain entity
- Declaring a lifecycle
- Adding an MCP tool
- Adding a REST endpoint
- Adding a report
- Interface conventions
- Dashboard widgets
- Lifecycles
- MCP tools
- MCP tool parameters : Assets
- MCP tool parameters : Compliance
- MCP tool parameters : Governance and context
- MCP tool parameters : General
- MCP tool parameters : Incidents
- MCP tool parameters : Reports and management review
- MCP tool parameters : Risks
- MCP tool parameters : System and administration
- MCP tool parameters : Trust Center
- Management commands
- Models
- Permissions
- REST endpoints
- Environment variables
- MCP server
- REST API
- Assistant module (Ask Cairn)
- Module 0: User Management and Access Control
- Module 1: Context and Organization
- Module 2: Asset Management
- Module 3: Compliance
- Module 4: Risk Management
- Module 4 bis - EBIOS Risk Manager
- Module 5 : Trust Center
- Module 6 : Security Incident Management
- Management review : ISO 27001:2022 compliance (clause 9.3)