Tools Reference

This page documents all tools available on the Priority MCP Server. Each tool description includes its parameters, response format, and usage notes.

Requirements: Priority ERP version 26.0 or above.

A note on company_name: Most tools require a company_name parameter. This must be the Name field value returned by the companies tool – not the Title field.

Limitations: File and attachment operations are not currently supported. This is planned for a future release.

companies

Retrieve the list of active companies available in your Priority ERP environment.

Parameters:

Response:

Returns company records with two fields:

• Name – The company identifier (use this value for company_name in other tools)
• Title – Human-readable description

Usage notes:

• Call this tool first to discover which companies are available
• Only active companies are returned
• The user’s permissions determine which companies appear

form_columns

Get column definitions and metadata for a Priority ERP form.

Parameters:

Response:

Each column includes:

• Name, Title, Type, Width (always present)
• Decimal – Numeric precision (when applicable)
• LinkedForm – The form that this field references. For example, a CUSTNAME field with LinkedForm: CUSTOMERS means valid values come from the CUSTOMERS form. Use this to understand field relationships and look up valid values.
• DateFormat – Expected input format for date/time columns (e.g., DD/MM/YY)

Boolean flags (shown only when true):

• Key – Part of the record’s unique key
• Mandatory – Required for record creation
• Readonly – Cannot be modified
• Hidden – Not displayed in the UI
• IsStatus – Status field

Usage notes:

• Use before form_update to identify key fields (including hidden ones)
• Key fields marked Hidden: true are still required when updating records

form_tree

Get the hierarchical form tree structure starting from a root form, showing all subforms and their relationships.

Parameters:

Response:

Returns a tree structure showing:

• Root form name and title
• Form properties (readonly, text type, subform type)
• Nested subforms with their own properties and sub-subforms

Usage notes:

• Use to understand which subforms are available for form_fetch and form_update
• The tree reflects the form hierarchy as it appears in the Priority UI

form_fetch

Retrieve records from Priority ERP forms with filtering, sorting, and pagination. Supports hierarchical queries across parent/child forms.

Parameters:

form_tree object:

Filter condition:

Wildcard support (for like operator):

• * matches any sequence of characters
• % matches any single character

Sort condition:

Date/time format for filter values:

Pagination:

• When top is omitted, results are limited to 100 records by default
• There is no indicator in the response when results are truncated – always specify top explicitly
• Use top and skip together for controlled pagination through large result sets

Response notes:

• Fields with empty, zero, or false boolean values are omitted from the response
• A missing field means it has no value, not that it does not exist on the form

form_update

Create or update records in Priority ERP forms. Supports hierarchical operations across parent and child forms.

Parameters:

root_form object:

Creating records:

• Leave record_keys empty
• Provide only the fields the user has specified
• Priority ERP has automatic triggers that fill most mandatory fields – do not ask for additional mandatory field data unless the server returns an error

Updating records:

• You must provide values for ALL key fields in record_keys, including hidden ones
• Use form_columns to identify all fields where Key: true, regardless of visibility
• Missing any key field will cause the update to fail

Date/time formats for field values:

Text forms (HTML):

• Forms identified by _is_html_form: true in form_fetch results contain HTML content
• When updating, provide content in the TEXT field using HTML format exactly as returned by form_fetch

entity_search

Search for forms, procedures, and reports in Priority ERP by name or title.

Parameters:

At least one of name_search or title_search must be provided.

Response:

Results are grouped into:

• Forms – Root level forms and direct sub-level forms accessible from menu
• Procedures and Reports – Each entry includes a procedure_type property (P for procedures, R for reports) which must be used when calling procedure_start

Usage notes:

• Name search is faster than title search
• Entity names in Priority are mostly uppercase
• Titles are stored in English; translate non-English terms before searching

enterprise_search

Full-text search across Priority ERP documents that have been configured for indexing.

Parameters:

Response:

Returns:

• Total results found and current offset
• Facet counts grouped by document type (form)
• Result entries with document name, type, company, ID, date, status, and highlighted snippets
• Suggestions when zero results are found

Usage notes:

• Only searches document types configured in the “Document Types in Search” form
• Run a broad search first to see facet counts, then use form_name to filter
• Date filters use ISO format (YYYY-MM-DD), unlike form tools which use DD/MM/YY

procedure_start

Start a Priority ERP procedure or report and return the first step.

Parameters:

Response:

Returns the first step of the procedure, including:

• session – Session ID (required for all subsequent procedure_continue calls)
• step_type – The type of step (see procedure_continue for handling each type)
• Step-specific data (input fields, options, messages)

Usage notes:

• Use entity_search to find the procedure name and determine its type (P or R)
• The session ID must be passed to every procedure_continue call
• See Procedures & Reports for the complete flow

procedure_continue

Continue a running procedure with the next action based on the current step type.

Parameters:

Action by step type:

Input fields:

When responding to an input step, you must send back ALL fields, including those you are not changing. Each field requires:

Current Value: Input fields may show a “Current Value” – this is the value from the last time the procedure was run, not a default. Use it as a starting point but adjust based on the current request.

help

Get help text for a Priority ERP entity (form, field, procedure, or report).

Parameters:

Usage notes:

• Returns the authoritative help text as configured in Priority ERP
• For forms, optionally pass field_name to get help for a specific column

skill_list

Retrieve all AI skill definitions from Priority ERP.

Parameters:

Response:

Returns skill records with:

• skill_code – Unique identifier for the skill
• skill_description – Brief description of what the skill does
• from_sync – Whether the skill was synchronized from a source

skill_fetch

Fetch the full content of a single AI skill by its code.

Parameters:

Response:

Returns the full skill_content text for the requested skill.

Usage notes:

• Use skill_list first to discover available skills and their codes
• Skills contain instructions that AI agents can follow when performing Priority ERP tasks