Skip to content

// integration

roXtra

Applies to

Product: Cloud · Server · Audience: Administrator

The roXtra connector lets the basebox assistant search the documents of your roXtra quality-management system, browse its folders and read documents. It changes nothing. With personal sign-in the assistant only reaches documents the person may see in roXtra.

What does the connector do?

This and the following sections are generated from the information the connector's image carries. What applies to every connector is described under What applies to every connector.

In the catalog it describes itself as:

Search and browse the documents of your roXtra quality-management system. With per-user logins the assistant only reaches documents that user may see.

It gives the assistant these instructions:

roXtra is the organisation's quality-management document system. Find documents with search_global, or browse from the root folder (id 100) with get_folder_content; both return document ids that get_file_details expands to the full metadata and get_file_content reads. Cite a document by its title and id; never imply you read a whole document when its text was truncated. Every call runs with the current user's own roXtra login, so results contain only what that user may see; a permission error means the user lacks access, not that the document does not exist.

Settings

The administrator fills in these fields in the connector's settings. They apply to the whole organisation.

Field Required Meaning
roXtra URL no The roXtra web root every request goes to. Example: https://qm.example.org/Roxtra
Help link for signing in no Where users can read how to get their roXtra login, e.g. a page on your intranet.

Sign-in

The administrator decides how the connector signs in: with Personal sign-in each person signs in with their own account and sees only what they may. With Company account everyone uses one account the administrator enters.

Personal sign-in

  • roXtra login – asks for a username and password. Your roXtra username and password. They are only ever sent to your roXtra server.

Company account

  • roXtra service account – asks for a username and password. A dedicated roXtra user, ideally with read-only rights on the documents everyone may see.

A company account gives everyone the same rights

Every basebox user reaches the system with the rights of this one account. Results are not trimmed to what each person may see.

The connector adds:

roXtra trims every result to what the signed-in user may see. A shared login flattens that: every basebox user will see whatever that one account can see.

Tools

The assistant can call 4 tools.

Tool Effect Description
get_file_content reads Read the text of one document in roXtra, the organisation's quality-management document system, by its numeric id. Returns the document's file name, its text (as Markdown where the document has headings or tables; scanned documents are read through OCR), which source the text came from (the original document, or roXtra's PDF rendition of a document that cannot be read directly), and whether the text was truncated. Fails if the current user may not open the document.
get_file_details reads Read the complete metadata of one document in roXtra, the organisation's quality-management document system, by its numeric id. Returns roXtra's Fields records as JSON, each with the field's id, its display caption and its value: title, description, keywords, file name, version, status, validity dates and any installation-specific fields. Does not return the document's file content. Fails if the current user may not open the document.
get_folder_content reads List the sub-folders and documents of one folder in roXtra, the organisation's quality-management document system. Returns roXtra's listing as JSON: FoldersList with each sub-folder's numeric id and title, and FilesList with each document's numeric id and metadata fields such as title, description, version and status. The root folder is 100 unless told otherwise. Only folders and documents the current user is allowed to see are returned.
search_global reads Search all documents in roXtra, the organisation's quality-management document system, by words in their text or metadata. Returns roXtra's search result as JSON: the matching documents with their numeric id and metadata fields such as title, description, keywords, version and status. Use a document's id with the file-details tool to read its complete metadata. Only documents the current user is allowed to see are returned.

Generated from mcp-roxtra:v0.2.1.