MCP Tool Definitions | Acumatica Knowledge MCP

Documentation

`search_docs`

Hybrid semantic and keyword search over Acumatica documentation. Returns page summaries with titles, breadcrumb paths, matched snippets, and image references.

Input	Type	Description
`query`	string	Search query, such as purchase order, generic inquiry parameters, or CustomerID. Required
`limit`	integer	Maximum results to return, from 1 to 10. Optional - Default `5`

`get_doc_page`

Get a full documentation page by GUID or exact title. Returns markdown content, breadcrumb path, source URL, and image references.

Input	Type	Description
`identifier`	string	Page GUID or exact title. Required

`get_doc_image`

Get a documentation image as base64 for visual display. Use image paths returned from get_doc_page or search_docs.

Input	Type	Description
`imagePath`	string	Local image path, for example images/abc123.png. Required

DAC Metadata

`search_dacs`

Semantic vector search for Acumatica DACs by business concept, field name, or table purpose. Returns compact DAC summaries.

Input	Type	Description
`query`	string	Semantic search query, such as cashflow, vendor payments, or inventory cost. Required
`limit`	integer	Maximum results to return, from 1 to 10. Optional - Default `5`

`get_dac`

Get a specific DAC by exact name. Supports compact summary, field, reference, and full detail views.

Input	Type	Description
`name`	string	Exact DAC name, such as CashAccount or APPayment. Required
`include`	string	Detail level: all, fields, references, or summary. Optional - Default `all`

`get_related_dacs`

Get all DACs connected to a given DAC through foreign-key references. Useful for discovering join paths.

Input	Type	Description
`name`	string	DAC name to find relationships for. Required
`direction`	string	Reference direction: incoming, outgoing, or both. Optional - Default `both`
`limit`	integer	Maximum relationships per direction, from 1 to 200. Optional - Default `50`
`offset`	integer	Zero-based offset per direction. Optional - Default `0`
`includeRelatedDetails`	boolean	Include compact related DAC details with fields. Optional - Default `false`

`search_by_field`

Find all DACs that contain a specific field name. Supports case-insensitive substring matching.

Input	Type	Description
`fieldName`	string	Field name to search for, such as CashAccountID. Required
`namespaceOrModule`	string	Optional namespace prefix or module segment, such as PX.Objects.IN or IN. Optional
`limit`	integer	Maximum results to return, from 1 to 200. Optional - Default `50`
`offset`	integer	Zero-based result offset. Optional - Default `0`

`list_dacs_in_namespace`

List all DACs in a given module namespace. Supports prefix matching, such as PX.Objects.AP matching PX.Objects.AP.Standalone.

Input	Type	Description
`namespace`	string	Namespace prefix, such as PX.Objects.AP or PX.Objects.CA. Required

OData

`search_odata`

Semantic vector search for Acumatica OData v4 entities. Returns compact summaries.

Input	Type	Description
`query`	string	Semantic search query, such as sales order payments or inventory transfers. Required
`limit`	integer	Maximum results to return, from 1 to 10. Optional - Default `5`

`get_odata_entity`

Get an OData entity by name, fully qualified name, or EntitySet/Singleton endpoint name.

Input	Type	Description
`name`	string	Entity name, full name, or endpoint name, such as SOOrder, SalesOrder, or PX.Objects.SO.SOOrder. Required
`include`	string	Detail level: all, properties, navigation, or summary. Optional - Default `all`

`search_odata_by_property`

Find all OData entities containing a specific property name. Supports case-insensitive substring matching.

Input	Type	Description
`propertyName`	string	Property name to search for, such as CustomerID or OrderNbr. Required
`namespaceOrModule`	string	Optional namespace prefix or module segment, such as PX.Objects.SO or SO. Optional
`limit`	integer	Maximum results to return, from 1 to 200. Optional - Default `50`
`offset`	integer	Zero-based result offset. Optional - Default `0`

`list_odata_in_namespace`

List all OData entities in a given namespace. Supports prefix matching across sub-namespaces.

Input	Type	Description
`namespace`	string	Namespace prefix, such as PX.Objects.SO or PX.Objects.AR. Required

`get_odata_navigation`

Get navigation properties and referential constraints for an OData entity. Shows $expand paths and join relationships.

Input	Type	Description
`name`	string	Entity name to get navigation properties for. Required
`direction`	string	Direction: to, from, or both. Optional - Default `both`
`limit`	integer	Maximum navigation rows per direction, from 1 to 200. Optional - Default `50`
`offset`	integer	Zero-based offset per direction. Optional - Default `0`
`summaryOnly`	boolean	Return compact navigation rows. Set false to return raw navigation objects. Optional - Default `true`

Contract-Based REST

`search_swagger`

Semantic vector search for Acumatica Contract-Based REST API entities. Returns compact summaries.

Input	Type	Description
`query`	string	Semantic search query, such as customer payments or inventory adjustments. Required
`limit`	integer	Maximum results to return, from 1 to 10. Optional - Default `5`

`get_swagger_entity`

Get a Contract-Based REST API entity by name. Returns properties, endpoints, actions, nested objects, and detail collections.

Input	Type	Description
`name`	string	Entity name, such as SalesOrder, Customer, or StockItem. Required
`include`	string	Detail level: all, properties, endpoints, actions, or summary. Optional - Default `all`

`search_swagger_by_property`

Find all Contract-Based REST API entities containing a specific property name. Supports case-insensitive substring matching.

Input	Type	Description
`propertyName`	string	Property name to search for, such as CustomerID or OrderNbr. Required
`limit`	integer	Maximum results to return, from 1 to 200. Optional - Default `50`
`offset`	integer	Zero-based result offset. Optional - Default `0`

`list_swagger_entities`

List all Contract-Based REST API entities, optionally filtered by name prefix. Returns compact summaries with counts.

Input	Type	Description
`prefix`	string	Optional name prefix filter, such as Sales or Purchase. Optional
`limit`	integer	Maximum results to return, from 1 to 200. Optional - Default `100`
`offset`	integer	Zero-based result offset. Optional - Default `0`

`get_swagger_schema`

Get a sub-schema definition used by Contract-Based REST API entities. Useful for detail entities, nested objects, and shared schemas.

Input	Type	Description
`name`	string	Sub-schema name, such as SalesOrderDetail, Address, or DocContact. Required

Generic Inquiry XML

`search_generic_inquiry_examples`

Search exported Acumatica Generic Inquiry XML examples by business concept, DAC, field, or XML pattern. Uses semantic search when available and falls back to keyword search.

Input	Type	Description
`query`	string	Search query, such as AR invoices by customer, ARInvoice CustomerID joins, or parameters. Required
`limit`	integer	Maximum results to return, from 1 to 10. Optional - Default `5`

`get_generic_inquiry_example`

Get an exported Generic Inquiry XML example by ID or exact title. Supports metadata, parsed, XML, summary, and full views.

Input	Type	Description
`identifier`	string	Example ID or exact title. Required
`include`	string	Detail level: all, metadata, parsed, xml, or summary. Optional - Default `all`

`list_generic_inquiry_examples`

List exported Generic Inquiry XML examples, optionally filtered by DAC, field, or feature pattern.

Input	Type	Description
`dac`	string	Optional DAC filter, such as ARInvoice. Optional
`field`	string	Optional field filter, such as CustomerID. Optional
`feature`	string	Optional feature filter, such as joins, parameters, or filters. Optional
`limit`	integer	Maximum results to return, from 1 to 100. Optional - Default `25`

`search_generic_inquiries_by_dac`

Find Generic Inquiry XML examples that reference a DAC name.

Input	Type	Description
`dac`	string	DAC name or partial DAC name, such as ARInvoice. Required
`limit`	integer	Maximum results to return, from 1 to 100. Optional - Default `25`

`search_generic_inquiries_by_field`

Find Generic Inquiry XML examples that reference a field name.

Input	Type	Description
`field`	string	Field name or partial field reference, such as CustomerID or ARInvoice.CustomerID. Required
`limit`	integer	Maximum results to return, from 1 to 100. Optional - Default `25`

`explain_generic_inquiry_xml`

Inspect a Generic Inquiry XML string and summarize its XML structure. This is a knowledge aid only and does not validate import compatibility.

Input	Type	Description
`xml`	string	Raw Generic Inquiry XML text. Required
`maxRepeatedPaths`	integer	Maximum repeated XML paths to return, from 1 to 200. Optional - Default `50`