> For the complete documentation index, see [llms.txt](https://help.fairmarkit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.fairmarkit.com/admin/fairmarkit-mcp-gateway-beta.md).

# Fairmarkit MCP Gateway (Beta)

### Overview

The Fairmarkit MCP Gateway provides one MCP endpoint for Fairmarkit capabilities.

The gateway aggregates tools from Fairmarkit services into a shared catalog. It routes each call to its owning service.

Connect an MCP-compatible client once. Then discover the tools available to your account.

### Connect to the MCP Gateway

Use the following production connection details:

* **MCP URL:** `https://app.fairmarkit.com/mcp`
* **Authentication:** Bearer token
* **Authorization header:** `Authorization: Bearer <PERSONAL_TOKEN>`

Configuration syntax varies by client. Enter the MCP URL and custom authorization header in the fields your client supports.

### Generate a personal token

Generate a personal token before connecting your client.

1. Sign in to Fairmarkit.
2. In the top-right navigation select the your user profile, then select **MCP Settings**.
3. Generate a personal token.
4. Copy the token into your MCP client configuration.

Open [MCP Settings](https://app.fairmarkit.com/buyer/mcp-settings) to generate or manage your token.

{% hint style="info" %}
Treat your personal token as a secret. Do not share it or commit it to source control. Revoke or regenerate an exposed token.
{% endhint %}

### Permissions and tool availability

The gateway scopes visible tools to your Fairmarkit user and tenant. Fairmarkit permissions, tenant configuration, and access controls can further limit each operation.

Some tool names include version suffixes, such as `_V1`, `_V2`, or `_V3`. Use every tool name exactly as the gateway returns it.

### Available tools

Your client discovers the tools available to your account after connecting. The following catalog groups documented tools by capability.

#### Analytics and data

* `list_standard_metrics` — List accessible metric definitions.
* `get_metric_definition` — Get a metric definition and calculation details.
* `list_cubes` — List live, allowlisted cubes and fields.
* `preview_cube_data` — Preview selected cube fields for a date range.
* `run_cube_query` — Run an allowlisted, tenant-scoped cube query.

#### Intake and request creation

* `predict_location` — Extract a delivery or service location.
* `predict_category` — Predict a tenant-specific procurement category.
* `create_request` — Create a sourcing request as a draft.

#### Schemas

* `get_current_schema` — Get the newest schema for the tenant.
* `get_schema_by_id` — Get an accessible tenant or global schema.

#### Requests

* `get_request` — Get a request’s title, status, field values, and linked records. Excludes line items.
* `update_request` — Change a draft or in-review request’s title, schema data, or both.
* `submit_request` — Validate a draft request and its items, then submit it for review.
* `add_request_items` — Add one or more items to a draft or in-review request.
* `update_request_item` — Replace one request item’s schema data.
* `delete_request_item` — Delete one item from a draft or in-review request.

#### Events and lifecycle

* `get_events_threads_V1` — List event and supplier thread IDs.
* `update_title_V1` — Change an event title.
* `update_event_details_V1` — Partially update event details and metadata.
* `update_event_urgency_V1` — Set event urgency to normal or urgent.
* `bulk_add_suppliers_V1` — Add multiple suppliers to an event.
* `remove_supplier_V1` — Remove a supplier, with an optional reason.
* `bulk_remove_suppliers_V1` — Remove multiple suppliers, with an optional reason.
* `change_supplier_contact_V1` — Replace an event supplier contact.
* `restore_removed_suppliers_V1` — Restore selected removed suppliers.
* `trigger_supplier_recommendations_V1` — Run supplier recommendations for an event.
* `cancel_event_V1` — Cancel an event with a reason.
* `close_event_V1` — Close an event.
* `extend_event_details_close_time_V1` — Change the closing time and optionally notify suppliers.
* `reassign_event_V1` — Assign an event to another user.
* `get_savings_V1` — Get event, response, and item savings.
* `get_items_savings_by_response_ids_V1` — Get item savings for specified responses.
* `complete_event_V1` — Mark an event as completed.
* `reopen_event_V1` — Reopen an event with a new closing time.
* `get_events_savings_V1` — Get savings for multiple events.
* `update_legal_document_id_V1` — Change a linked legal document.
* `update_legal_document_enforcement_policy_V1` — Change a legal document’s enforcement policy.
* `remove_module_V1` — Remove a module type from an event.
* `get_suppliers_module_V2` — Get active and removed event suppliers.
* `open_event_V2` — Validate and open an event.
* `get_details_module_V2` — Get an event’s details module.
* `get_legal_documents_module_V2` — Get event legal documents and enforcement settings.
* `get_event_V3` — Get core event details and module summaries.
* `get_events_V3` — List events with search, lifecycle, and ownership filters.
* `get_event_detailed_V3` — Get complete event and module details.

#### Event modules and responses

* `update_event` — Change a draft event’s title and Details fields.
* `get_events_by_request` — List every event for a request, oldest to newest.
* `get_event_details_module` — Get an event’s Details module, filtered by permissions.
* `get_event_pricing_module` — Get Pricing module metadata and a paginated item list.
* `get_event_suppliers_module` — Get the Suppliers module with company and contact details.
* `add_supplier_to_event` — Add one supplier by ID, UUID, email, or name.
* `remove_supplier_from_event` — Remove one supplier and return a removal receipt.
* `list_event_responses` — List supplier responses, status, timestamps, and attachments.

#### Worksheets

* `add_worksheets_module_V1` — Add a worksheets module to an event.
* `add_lot_V1` — Create a worksheet lot.
* `clone_lot_V1` — Duplicate a worksheet lot.
* `update_lot_ordering_V1` — Move a worksheet lot to a position.
* `get_worksheet_lot_by_id_V1` — Get a worksheet lot and its schema.
* `bulk_add_worksheet_rows_V1` — Create multiple worksheet rows.
* `bulk_update_worksheet_rows_V1` — Update multiple rows and report results.
* `bulk_delete_worksheet_rows_V1` — Delete multiple rows and report results.
* `get_worksheet_rows_by_lot_id_V1` — List rows in a worksheet lot.
* `remove_rows_V1` — Remove all rows from a worksheet lot.
* `get_worksheet_row_by_id_V1` — Get one worksheet row.
* `update_worksheet_row_ordering_V1` — Move a row within its lot.
* `update_worksheet_lot_schema_V1` — Replace a lot schema with concurrency checking.
* `update_worksheet_lot_field_type_V1` — Update a lot field type and schema.
* `update_worksheet_lot_title_V1` — Change a worksheet lot title.
* `search_worksheet_lots_V3` — Search worksheet lots for a request.
* `search_worksheet_rows_V3` — Search worksheet rows for a request.

#### Pricing

* `get_pricing_module_V1` — Get an event’s pricing module.
* `bulk_create_items_V1` — Create multiple pricing items.
* `bulk_update_items_V1` — Update multiple pricing items and report results.
* `bulk_delete_items_V1` — Delete multiple pricing items and report results.
* `clone_pricing_item_V1` — Duplicate a pricing item.
* `delete_item_V1` — Delete one pricing item.
* `update_pricing_module_schema_V1` — Replace the pricing schema with concurrency checking.
* `validate_items_V1` — Validate pricing items against the module schema.
* `update_pricing_V1` — Replace pricing-module metadata.
* `search_pricing_items_V3` — Search pricing items for a request.

#### Event pricing items

* `create_event_pricing_items` — Add pricing items to a draft event.
* `update_event_pricing_items` — Change pricing items on a draft event.
* `delete_event_pricing_items` — Remove pricing items from a draft event.

#### Documents

* `get_documents_DOCUMENT_V1` — List documents with filtering and pagination.
* `delete_DOCUMENT_V1` — Soft-delete a document.
* `duplicate_document_DOCUMENT_V1` — Create a standalone copy of a document.
* `update_title_DOCUMENT_V1` — Change a document title.
* `update_content_DOCUMENT_V1` — Add and publish a document-content version.

#### Messaging, files, and users

* `send_message` — Send a message to a thread.
* `get_thread_updates` — Get new, edited, and deleted messages since the last read.
* `mark_thread_as_read` — Mark a thread as read.
* `create_file_upload` — Prepare a named file for upload.
* `get_file_download_links` — Create short-lived download links for files.
* `get_users` — Search or list users.

#### Questionnaires

* `create_questionnaire_module_V2` — Add a questionnaire module to an event.
* `delete_questionnaire_V2` — Delete a questionnaire module.
* `get_questionnaire_sections_V2` — List questionnaire sections.
* `generate_questionnaire_sections_V2` — Generate questionnaire sections, with an optional prompt.
* `update_questionnaire_section_header_V2` — Change a section title and description.
* `update_questionnaire_section_ordering_V2` — Move a questionnaire section.
* `delete_questionnaire_section_V2` — Delete a questionnaire section.
* `create_questionnaire_section_question_group_V2` — Create a question group.
* `create_questionnaire_section_question_V2` — Create a questionnaire question.
* `create_questionnaire_section_conditional_question_V2` — Create a conditional question.
* `generate_questionnaire_section_questions_V2` — Generate questions for a questionnaire section.
* `move_all_questionnaire_section_items_V2` — Move every item to another section.
* `update_questionnaire_section_item_title_V2` — Change a questionnaire item title.
* `set_questionnaire_section_item_required_V2` — Mark a questionnaire item as required.
* `set_questionnaire_section_item_optional_V2` — Mark a questionnaire item as optional.
* `update_questionnaire_section_item_answer_type_V2` — Change a question’s answer type and settings.
* `update_questionnaire_section_item_condition_V2` — Change a conditional-question condition.
* `update_questionnaire_section_item_attachments_V2` — Replace item attachments.
* `delete_questionnaire_section_item_V2` — Delete a questionnaire item.
* `convert_questionnaire_section_item_to_question_group_V2` — Convert an item into a question group.
* `convert_questionnaire_section_item_to_question_V2` — Convert an item into a regular question.
* `update_questionnaire_section_item_to_conditional_question_V2` — Convert an item into a conditional question.
* `move_questionnaire_section_item_V2` — Move an item to another location.
* `move_questionnaire_section_item_children_V2` — Move an item’s children.
* `clone_questionnaire_section_item_V2` — Clone a questionnaire item.
* `get_questionnaire_section_items_V2` — List questionnaire items with hierarchy and filters.

#### Projects

* `list_projects_PROJECT_V1` — List visible, non-deleted projects.
* `get_project_PROJECT_V1` — Get project details, status, modules, and timestamps.
* `delete_project_PROJECT_V1` — Soft-delete a project and revoke team permissions.
* `get_project_workflow_PROJECT_V1` — Get the project workflow and its statuses.
* `get_project_allowed_transitions_PROJECT_V1` — List statuses reachable from the current status.
* `get_project_allowed_modules_PROJECT_V1` — List project modules available to the current user.
* `copy_project_PROJECT_V1` — Create a permitted copy of a project.
* `change_project_status_PROJECT_V1` — Move a project to an allowed workflow status.
* `change_project_owner_PROJECT_V1` — Transfer project ownership to a team member.
* `update_project_title_PROJECT_V1` — Change a project title.
* `update_project_description_PROJECT_V1` — Change a project description.
* `update_project_details_schema_data_PROJECT_V1` — Validate and save project detail data.
* `update_project_planned_start_date_PROJECT_V1` — Set or clear the planned start date.
* `update_project_planned_end_date_PROJECT_V1` — Set or clear the planned end date.
* `update_project_actual_start_date_PROJECT_V1` — Update the actual start date.
* `update_project_actual_end_date_PROJECT_V1` — Update the actual end date.
* `create_project_V2` — Create a project from an active template.

#### Project milestones and tasks

* `delete_project_milestone_PROJECT_V1` — Delete a user-defined milestone.
* `update_project_milestone_title_PROJECT_V1` — Change a milestone title.
* `update_project_milestone_description_PROJECT_V1` — Change a milestone description.
* `reassign_project_milestone_PROJECT_V1` — Assign or clear a milestone assignee.
* `complete_project_milestone_PROJECT_V1` — Mark a milestone as done.
* `reopen_project_milestone_PROJECT_V1` — Return a completed milestone to TODO.
* `update_project_milestone_ordering_PROJECT_V1` — Move a milestone to a position.
* `update_project_milestone_task_description_PROJECT_V1` — Change a milestone task description.
* `update_project_milestone_task_title_PROJECT_V1` — Change a milestone task title.
* `update_project_milestone_task_ordering_PROJECT_V1` — Move a task within its milestone.
* `complete_project_milestone_task_PROJECT_V1` — Mark a milestone task as done.
* `reopen_project_milestone_task_PROJECT_V1` — Return a completed task to TODO.
* `reassign_project_milestone_task_PROJECT_V1` — Assign or clear a task assignee.
* `delete_project_milestone_task_PROJECT_V1` — Delete a manually created milestone task.
* `list_project_milestones_V2` — List project milestones in order.
* `create_project_milestone_V2` — Create a custom TODO milestone.
* `get_project_milestone_V2` — Get one project milestone.
* `update_project_milestone_scheduled_date_V2` — Set or clear a milestone scheduled date.
* `update_project_milestone_completed_date_V2` — Set a completed milestone date.
* `create_project_milestone_task_V2` — Create a manual TODO task under a milestone.
* `update_project_milestone_task_scheduled_date_V2` — Set or clear a task scheduled date.
* `update_project_milestone_task_completed_date_V2` — Set or clear a completed task date.
* `list_project_milestone_tasks_V2` — List tasks for a project milestone.

#### Project documents and team

* `list_project_documents_PROJECT_V1` — List non-deleted project documents.
* `list_project_document_versions_PROJECT_V1` — List document versions from newest to oldest.
* `list_project_team_members_PROJECT_V1` — List team members, roles, and permissions.
* `add_project_team_member_PROJECT_V1` — Add a member with a project role.
* `count_project_team_members_PROJECT_V1` — Count project team members.
* `remove_project_team_member_PROJECT_V1` — Remove an eligible project team member.
* `reassign_project_team_member_role_PROJECT_V1` — Change a non-owner team member’s role.

#### Project templates and workflows

* `get_project_templates_PROJECT_TEMPLATE_V1` — List visible tenant and global project templates.
* `get_project_template_PROJECT_TEMPLATE_V1` — Get visible project-template metadata.
* `list_project_statuses_PROJECT_STATUS_V1` — List accessible tenant and system project statuses.
* `list_workflow_templates_WORKFLOW_TEMPLATE_V1` — List accessible tenant and global workflow templates.
* `get_workflow_template_WORKFLOW_TEMPLATE_V1` — Get one accessible workflow template.

#### Workflows

* `list_general_workflows` — List approved general workflows available to the tenant.
* `list_tenant_workflows` — List the tenant’s draft and published workflow versions.
* `get_workflow_definition` — Get a workflow version’s definition and input and output schemas.
* `create_workflow_draft` — Register a workflow definition as a tenant draft.
* `publish_workflow` — Publish a workflow with its trigger source and schemas.

### Quick reference

1. Generate a Fairmarkit personal token.
2. Configure `https://app.fairmarkit.com/mcp`.
3. Set `Authorization: Bearer <PERSONAL_TOKEN>`.
4. Connect your MCP client and discover available tools.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.fairmarkit.com/admin/fairmarkit-mcp-gateway-beta.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
