Admin MCP · Tools
Start with your task. Expand a group only when you need tool names and access details. Complete connection and authorization first; the AI selects tools using the connected service’s schemas.
The index covers the implemented default tool surface, not optional legacy/report tools. Deployment, organization and authorization determine actual availability; use tools/list and current capability responses rather than a fixed count.
Choose a capability
| Capability | What you can do |
|---|---|
| Organization and navigation | Confirm the organization, capabilities and usage, then locate projects, workspaces or codes. |
| Code creation and editing | Create content, redirect, multi-link or static codes. Read edit state before changing supported existing resources. |
| Templates and batch creation | Build consistent registers and verify results per source item. Review the impact of existing-template edits separately. |
| Official templates | Search official templates, inspect compatible fields, prepare a plan and execute creation. |
| Images and files | The client reads selected local files, uploads bytes and checks state before referencing file_key in creation. |
| Forms, records and activity | Create forms, including supported scored questions, read submissions and follow-up activity; edit only within the returned scope. |
| Recurring plans and inspection progress | Find plans, inspect schedules and drill down from completion totals to specific unfinished codes. |
| Label previews and downloads | Preview a few real codes, then export explicitly selected codes using their existing style; no shared-style changes. |
| Metrics and analysis | Discover metrics and definitions before querying supported time ranges, scopes and dimensions; drill into records where supported. |
Existing-content edits
Code, child, form and template edits save real changes. Explicitly identify the resource and changes, read current edit state/version, and inspect template impact. Code/form editing is currently limited to supported AI-created resources; a listed tool is not permission to edit arbitrary data. Client confirmation does not replace server authorization.
Grouped tool index
All groups start collapsed. Tables show OAuth operation scopes; “Current read access” means the existing read authorization path, not public access. Read-only tools may still require write scopes when inspecting uploads, edit state or creation tasks.
Organization and navigation
Confirm the organization, capabilities and usage, then locate projects, workspaces or codes.
Expand · 8 tools
| Tool | Purpose and limits | Effect | OAuth scope |
|---|---|---|---|
auth_get_context | Current organization, authentication, scopes and available operations | Read only | Valid credential |
usage_get | Daily MCP/API usage, reservations, remaining allowance and reset time; not subscription capacity | Read only | Valid credential |
projects_list | Project list | Read only | Current read access |
workspaces_list | Workspace list | Read only | Current read access |
views_list | Views within a workspace | Read only | Current read access |
view_nodes | View directory nodes; not directory editing | Read only | Current read access |
qrcodes_list | Dynamic code list | Read only | Current read access |
qrcodes_get_operation | Form and action entries associated with a code | Read only | Current read access |
Code creation and editing
Create content, redirect, multi-link or static codes. Read edit state before changing supported existing resources.
Expand · 10 tools
| Tool | Purpose and limits | Effect | OAuth scope |
|---|---|---|---|
qrcode_get | Read one code’s content | Read only | Current read access |
qrcodes_create | Create a content code with supported text, images, files, links and forms | Create | qrcodes.write |
qrcodes_create_url_jump | Create a dynamic code redirecting to a website | Create | qrcodes.write |
qrcodes_create_multi_url | Create a dynamic code showing 1–100 titled links | Create | qrcodes.write |
static_qrcodes_create | Create a text/URL static code; immutable content, no scan statistics | Create | qrcodes.write |
qrcodes_get_edit_state | Read code kind, version and current editable scope | Read only | qrcodes.write |
qrcodes_edit | Edit an AI-created content code; retain existing components by ref | Edit existing | qrcodes.write |
qrcodes_edit_url_jump | Edit an AI-created redirect code without changing its code URL | Edit existing | qrcodes.write |
qrcodes_edit_multi_url | Edit an AI-created multi-link code; replace the entire links array | Edit existing | qrcodes.write |
qrcode_children_edit | Edit one AI-created child code; submit only changed variable fields | Edit existing | qrcodes.write |
Templates and batch creation
Build consistent registers and verify results per source item. Review the impact of existing-template edits separately.
Expand · 14 tools
| Tool | Purpose and limits | Effect | OAuth scope |
|---|---|---|---|
templates_list | Batch template list | Read only | Current read access |
templates_get | Template structure | Read only | Current read access |
templates_list_qrcodes | Children of a selected template | Read only | Current read access |
templates_get_qrcode | Child code content | Read only | Current read access |
qrcodes_list_create_targets | Allowed projects/directories for creation | Read only | templates.read |
templates_list_editable | Creation/edit candidates; select first, then read schema | Read only | templates.read |
templates_get_schema | Fields, types, capabilities and template version | Read only | templates.read |
templates_create | Save a new basic-information template | Create | templates.write |
qrcodes_prevalidate | Validate batch inputs without creating codes | Read only | qrcodes.write |
qrcodes_create_batch | Create up to 100 children per batch | Create | qrcodes.write |
qrcode_tasks_get | Creation task state; not proof of every item’s readiness | Read only | qrcodes.write |
qrcode_tasks_get_results | Per-item results, links and content readiness by item_key | Read only | qrcodes.write |
templates_preview_edit | Preview a template edit and impact; no content save | Read only | templates.write |
templates_edit | Edit an existing template, potentially affecting existing children | Edit existing | templates.write |
Official templates
Search official templates, inspect compatible fields, prepare a plan and execute creation.
Expand · 5 tools
| Tool | Purpose and limits | Effect | OAuth scope |
|---|---|---|---|
gallery_categories | Official template categories | Read only | templates.read |
gallery_list | Keyword search or category browsing | Read only | templates.read |
gallery_get | Template details, fillable fields and compatibility | Read only | templates.read |
gallery_prepare_creation | Validate and store a temporary creation plan; not a pure read | Temporary resource | templates.write + qrcodes.write |
gallery_create_from_plan | Install the selected template and create codes from the plan | Create | templates.write + qrcodes.write |
Images and files
The client reads selected local files, uploads bytes and checks state before referencing file_key in creation.
Expand · 2 tools
| Tool | Purpose and limits | Effect | OAuth scope |
|---|---|---|---|
assets_request_upload | Allocate a temporary upload; the client must PUT local file bytes | Temporary resource | assets.write |
assets_get_upload | Poll upload state by file_key; only temporary_available can be used | Read only | assets.write |
Forms, records and activity
Create forms, including supported scored questions, read submissions and follow-up activity; edit only within the returned scope.
Expand · 8 tools
| Tool | Purpose and limits | Effect | OAuth scope |
|---|---|---|---|
forms_list | Readable forms | Read only | Current read access |
form_get | Form structure and field definitions | Read only | Current read access |
forms_create | Create a form, optionally with a recurring schedule or supported scoring | Create | templates.write |
forms_get_edit_state | Read persistent field IDs, version and editable scope | Read only | templates.write |
forms_edit | Edit an AI-created form using a full field snapshot; no field/option deletion or type changes | Edit existing | templates.write |
record_list | Search record summaries, respecting filters and truncation | Read only | Current read access |
record_get | Read one submission | Read only | Current read access |
record_activities_list | Paginate comments, attachments, progress changes and related form references; does not mark read | Read only | records.read |
Recurring plans and inspection progress
Find plans, inspect schedules and drill down from completion totals to specific unfinished codes.
Expand · 4 tools
| Tool | Purpose and limits | Effect | OAuth scope |
|---|---|---|---|
cycle_plans_list | Discover and filter recurring plans | Read only | records.read |
cycle_plans_get | Read full plan configuration and overview | Read only | records.read |
cycle_tasks_get_completion | Completion overview for the requested range | Read only | records.read |
cycle_tasks_list_qrcodes | Codes and execution facts within a native period | Read only | records.read |
Label previews and downloads
Preview a few real codes, then export explicitly selected codes using their existing style; no shared-style changes.
Expand · 4 tools
| Tool | Purpose and limits | Effect | OAuth scope |
|---|---|---|---|
labels_get_config | Current style, fields, sizes and supported formats | Read only | templates.read |
labels_preview | Render up to 3 explicit targets; consumes rendering resources | Generate files | templates.read |
label_exports_create | Export one ordinary code or up to 100 children of one template | Generate files | qrcodes.write |
label_exports_get | Export state and authorized download files | Read only | qrcodes.write |
Metrics and analysis
Discover metrics and definitions before querying supported time ranges, scopes and dimensions; drill into records where supported.
Expand · 3 tools
| Tool | Purpose and limits | Effect | OAuth scope |
|---|---|---|---|
list_metrics | Discover business objects and available metrics | Read only | Current read access |
get_metric | Metric definition, dimensions and limitations | Read only | Current read access |
query_metrics | Query supported metrics, groupings and drill-down filters | Read only | Current read access |
Permission and result boundaries
Member reads follow current resource permissions and field visibility. Totals can be unknown and results truncated; narrow the scope rather than extrapolating from samples. A denied activity read does not mean no follow-up occurred. Scan events, visitors, submitters and completed checks are different measures.
An explicitly authorized task may proceed within the agreed scope; resolve ambiguous mappings or expanded edits before saving. Form edits require the full field snapshot; multi-link edits replace the whole links list. Version conflicts require rereading current state, not a forced overwrite.
Typical workflows
- Equipment register: choose target/template → match rows and photos → upload and confirm temporary_available → validate → create → verify per-item results.
- Official template: search → inspect compatibility → organize inputs → prepare plan → review → execute → query original results.
- Recurring inspection: create form/schedule → bind while creating codes/template → children inherit the schedule → people submit → query unfinished codes and records. Per-batch schedule overrides are not supported.
- Labels: select explicit ready code IDs → inspect style → preview → export → download. a4_pdf may be an archive containing PDFs rather than a direct PDF.
Recovery and compatibility
A successful task or returned ID does not prove all content or attachments are ready. Inspect item states, errors and truncation. On timeout preserve the request, idempotency key and task ID; do not blindly recreate resources.
The metric names remain list_metrics, get_metric, query_metrics. Older documentation used record_get_form_list and templates_get_subcode; use forms_list and templates_get_qrcode from the current tools list. Legacy availability depends on the service; no additional compatibility window is promised here.
record_add_record and certificates_verify are not on the default MCP tool surface. REST availability does not imply MCP exposure. See the API Reference and Error codes and rate limits.