Konquest MCP Server Tool Reference
This article lists every tool currently available through the Konquest MCP server, grouped by area. For help connecting Claude to your Konquest account, see Using the Konquest MCP Server with Claude.
Overview
The Konquest MCP server is actively developed, so new tools are added regularly - the list below reflects what's available at the time of writing. You don't need to know the exact tool names to use Claude with Konquest; Claude selects the right tool (or combination of tools) based on what you ask for in natural language. This reference is useful if you want to understand exactly what Claude can and can't do on your account, or if you're troubleshooting why a request didn't work as expected.
Placements & Custom Fields
| Tool | Purpose |
|---|---|
create_placement |
Create a single placement |
search_placements |
Search for existing placements |
get_placements_by_source |
Get placements by their source IDs for a given source system |
get_placement_settings |
Get the placement settings configured for the account |
get_placement_rules |
List the placement rules in use for an account |
set_placement_beneficiaries |
Assign beneficiaries to a placement |
set_placement_custom_field |
Set a custom field on a placement |
set_value_custom_field |
Set a dated value custom field on a placement |
set_many_value_custom_fields |
Set multiple dated value custom fields on a placement in a single call |
approve_placement |
Approve a placement |
unapprove_placement |
Unapprove a placement |
cancel_placement |
Cancel a placement |
revert_placement_cancellation |
Revert a placement cancellation |
import_placements |
Bulk import or update placements in Konquest |
get_recent_imports |
Get recent placement and timesheet imports, to check progress and status |
Timesheets
| Tool | Purpose |
|---|---|
add_timesheet |
Add a single timesheet entry to a placement |
delete_timesheet |
Delete a timesheet using the placement ID and the timesheet ID |
import_timesheets |
Bulk add timesheets to existing placements in Konquest |
Users, Beneficiaries & Teams
| Tool | Purpose |
|---|---|
create_beneficiary |
Create a new user/beneficiary |
get_users |
List all users/beneficiaries on the account |
get_beneficiary_contribution_types |
Retrieve valid beneficiary role values |
get_teams |
Get all teams for an account |
set_user_thresholds |
Set a threshold for a user |
get_user_thresholds |
Retrieve thresholds for a user |
Scheme Enrolment
| Tool | Purpose |
|---|---|
enrol_to_scheme |
Enrol a user into a scheme |
enrol_to_scheme_for_team |
Enrol a user onto a scheme with a team qualification |
disenrol_from_scheme |
Remove a user from a scheme |
delete_scheme_enrolment |
Delete a user's scheme enrolment entirely - no disenrolment date is set, so the scheme is removed from their calculations completely |
get_user_enrolments |
Get the full scheme enrolment history for a user |
Scheme Setup & Lifecycle
| Tool | Purpose |
|---|---|
get_schemes |
List available schemes |
get_scheme |
Get a single scheme by its identifier |
create_scheme |
Create a new, empty commission scheme |
duplicate_scheme |
Copy an existing scheme, including its bands and configuration |
set_scheme_name |
Rename a scheme |
set_scheme_description |
Set the description text on a scheme |
set_scheme_consultant_summary |
Set the consultant-facing summary on a scheme |
describe_scheme |
Produce a plain-prose description of a scheme, aimed at an enrolled consultant |
set_scheme_currency |
Set the ISO currency code a scheme pays in |
Scheme Configuration (Timing & Payment)
| Tool | Purpose |
|---|---|
set_scheme_accumulation_type |
Set how often billings accumulate before payment bands are applied |
set_scheme_payment_period |
Set how often the scheme pays out (weekly, monthly, quarterly, annual) |
set_scheme_payment_offset |
Delay payout by a number of periods after the earning period |
remove_scheme_payment_offset |
Remove the payment offset, so the scheme pays in the period it was earned |
enable_scheme_pay_when_paid |
Only pay commission once the client has paid |
disable_scheme_pay_when_paid |
Pay commission without waiting for client payment |
set_scheme_pay_when_paid_delay |
Set how many periods after client payment a pay-when-paid scheme pays |
categorise_scheme_as_bonus |
Categorise a scheme as a bonus scheme |
categorise_scheme_as_commission |
Categorise a scheme as a commission scheme (the default) |
set_scheme_calculate_against |
Set which placement date decides the period a billing counts in |
set_scheme_enrol_against |
Set which placement date is compared against a user's enrolment dates |
set_scheme_calendar |
Set the calendar a scheme uses for its period boundaries |
Payment Bands
| Tool | Purpose |
|---|---|
add_percentage_band |
Add a band paying a percentage of the billings falling within it |
add_percentage_above_band |
Add an open-ended top band paying a percentage of everything above its start |
add_percentage_below_band |
Add a band paying a percentage of the billings below its start |
add_fixed_band |
Add a band paying a one-off amount for reaching its start |
add_fixed_quantity_band |
Add a band paying a fixed amount per placement made or timesheet worked |
add_individual_threshold_band |
Add a team-scheme band gated on an individual member's billings |
delete_scheme_band |
Remove a payment band from a scheme |
set_band_start |
Set the value a payment band starts at |
set_band_rate |
Set a payment band's rate |
make_band_recurring |
Make a fixed quantity band pay every time the quantity is reached |
stop_band_recurring |
Make a fixed quantity band pay only once |
add_band_payout_filter |
Narrow a band to pay only on billings matching a performance type |
add_compound_band_payout_filter |
Narrow a band using several performance types that must all match |
Performance Types, Payment Rules & Contribution Types
| Tool | Purpose |
|---|---|
add_scheme_required_performance_type |
Add a required performance type controlling which billings accumulate |
remove_scheme_required_performance_type |
Remove a required performance type from a scheme |
add_compound_scheme_required_performance_type |
Add a required performance type made up of several types that must all match |
add_scheme_payment_rule |
Add a rule that billings must meet before they're paid |
remove_scheme_payment_rule |
Remove a payment rule from a scheme |
add_scheme_beneficiary_contribution_type |
Restrict the scheme to a beneficiary contribution type (role) |
remove_scheme_beneficiary_contribution_type |
Remove one contribution type restriction |
set_scheme_beneficiary_contribution_types |
Replace the restrictions with exactly the roles given |
clear_scheme_beneficiary_contribution_types |
Remove all contribution type restrictions |
Statements & Adjustments
| Tool | Purpose |
|---|---|
get_user_statement |
Retrieve a user's statement for a given date (today or in the past) - shows how much commission they're earning |
get_user_calculation |
Get a user's calculation, including support for setting a calculation date |
add_adjustment |
Add a manual adjustment to a user's statement, optionally dated to a forward- or backward-looking period |
Need Help?
If you're not sure which tool Claude used for a particular request, or a result doesn't match what you expected, contact your Konquest support contact with the prompt you gave Claude and, if possible, the tool name shown in its response.