Skip to Content
IntegrationsMCP Tool Reference

MCP Tool Reference

This page lists the tools the ScopeStack MCP server exposes to your AI assistant, and records the older tools they replaced. You don’t call these by hand — your assistant chooses them based on what you ask. The list is here so you know what’s possible and can phrase requests precisely.

A few things to keep in mind:

  • Reads vs. Writes — “Reads” tools only look things up. “Writes” tools create, update, or delete data in your account. Both obey your role’s permissions; an assistant can’t write what your role can’t.
  • Required inputs are the values a tool needs before it can run. Your assistant gathers these from your request or by calling a “Reads” tool first (for example, searching for a client before creating a project).
  • For how IDs flow from one tool to the next and an end-to-end example, see How the MCP Works.

The older tools have been removed. In October 2026 ScopeStack removed the tools listed under Superseded tools, so your assistant can no longer call them. Use the tools below and the migration map to translate an older call.

The consolidated tools

Rather than one tool per operation, each of these takes a selector argument that says which kind of record you mean. Fewer tools means your assistant picks the right one more reliably, which matters most when ScopeStack is connected alongside other MCP servers.

ToolWhat it does
scopestack_list_project_itemsRead anything on a project, or search projects. Selector: type, which includes documents (the project’s generated files, newest first).
scopestack_project_item_writeCreate or update anything on a project. Selectors: type + action.
scopestack_list_settingsRead any catalog or account-configuration list. Selector: model.
scopestack_settings_writeCreate, update or delete catalog records. Selectors: model + action.
scopestack_update_service_languageUpdate SOW language on a project service.
scopestack_tool_guidanceWorkflow reference for the tools above.

Alongside these, scopestack_whoami reports which ScopeStack account and user the session is connected to. It is read-only and takes no inputs, so it is a good first call in any session.

Research tools are limited to ScopeStack site administrators during early access. The server includes them in tool discovery only for those administrators.

Project phases

scopestack_list_project_items with type: "phases" lists the phases on one project, in order. Each phase carries its id, name, sow_language, position and phase_id. The phase_id points to one of the account’s standard phases, and it is null for a custom phase that exists only on that project.

scopestack_project_item_write with type: "phase" and action: "upsert" adds a phase to a project. Pass phase_id to add one of the account’s standard phases, or name alone to add a custom phase. A name passed along with phase_id gives the standard phase a different name on that project. position is optional and 1-based; without it the new phase goes last. This only adds phases. It cannot rename, move or remove a phase already on the project. New projects already start with every active account phase, so you need it for a standard phase added to the account later, one removed from the project, or a custom phase.

To put a service in a phase, pass the phase’s name as phase_name on a type: "service" upsert. The name is matched against the project’s own phase names first, so custom and renamed phases work, and then against the account’s standard phase names.

Project governance and actual hours

Use scopestack_list_project_items with project_id and one of these selectors:

Selector exampleMinimum permissionWhat it returns
type: "governances", project_id: "123"Project Governance · ViewActive governance items in order. An empty list means the project has no active governance items.
type: "post_mortem", project_id: "123"Project Overview · ViewEstimated and actual hours for services tracked in the PSA. Totals include only settled services. no_delivery_data means no PSA delivery data has been recorded for the project. not_enabled means the feature is off for the account.

For percentage-based governance, applicable_effort is the base the percentage applies to. It can be the project’s eligible service hours or a subtotal for a phase or line of business. effective_rate is the first rule rate that matches the effort and pricing model, or the base rate if no rule matches. Fixed-hours items omit these two fields.

Changing a project’s rate table

On an existing project, scopestack_project_item_write with type: "project", action: "upsert" and the project_id accepts rate_table_id, which moves the project to that rate table. It must be an active rate table on your account. Any other ID returns “Rate table not found on this account” and leaves the project unchanged.

Changing the rate table re-prices the project’s standard resources and the services that use them. Each standard resource takes the new table’s rates, replacing any rate, external name or description edited on the project. Vendor resources and products keep their prices, and the project takes the new table’s currency. A standard resource is removed from the project when the new table has no matching rate for it. A rate matches only when it is for the same resource and the same line of business or service category, so a resource priced for one line of business is removed if the new table has only an All Lines of Business rate for it, and the reverse. The project overview (type: "overview") reports the project’s rate_table by id and name.

AI instructions on services

A catalog service or subservice can carry ai_instructions: directions your account writes for AI assistants on how to scope it, such as questions to ask, companion services to consider, or constraints. Write them with scopestack_settings_write (model: "service" or model: "subservice") in the ai_instructions field, up to 4,000 characters. When you create a service, each entry in its subservices can carry its own.

They come back on scopestack_list_settings with model: "services" and response_format: "full", in the response when a service is added to a project, and on every service and subservice in the project overview. They are internal. scopestack_tool_guidance tells the assistant to follow them while scoping and never to copy them into a service description, SOW language or any other customer-facing field.

Migration map

Find the old tool in the left column. The right column is the exact replacement call, including the selector values.

Old toolReplacement
get_projectscopestack_list_project_items type: "overview", project_id: <id>
get_project_document_statusscopestack_list_project_items type: "document_status", project_document_id: <id>, response_format: "detailed"
list_project_contactsscopestack_list_project_items type: "contacts", project_id: <id>
list_project_locationsscopestack_list_project_items type: "locations", project_id: <id>
list_project_resourcesscopestack_list_project_items type: "resources", project_id: <id>
list_project_surveysscopestack_list_project_items type: "surveys", project_id: <id>
review_project_scopescopestack_list_project_items type: "scope_review", project_id: <id>
search_projectsscopestack_list_project_items type: "projects" (same filters, including the date filters; no project_id)
add_price_adjustment_to_projectscopestack_project_item_write type: "price_adjustment", action: "upsert", project_id: <id>
add_product_to_projectscopestack_project_item_write type: "product", action: "upsert", project_id: <id>
add_project_contactscopestack_project_item_write type: "contact", action: "upsert", project_id: <id>
add_project_locationscopestack_project_item_write type: "location", action: "upsert", project_id: <id>
add_resource_rate_to_projectscopestack_project_item_write type: "resource_rate", action: "upsert", project_id: <id>
add_service_to_projectscopestack_project_item_write type: "service", action: "upsert", project_id: <id>
add_vendor_resource_to_projectscopestack_project_item_write type: "vendor_resource", action: "upsert", project_id: <id>
apply_blueprint_to_projectscopestack_project_item_write type: "blueprint", action: "apply", project_id: <id>
apply_questionnaire_to_projectscopestack_project_item_write type: "questionnaire", action: "apply", project_id: <id>
create_blueprint_from_projectscopestack_project_item_write type: "blueprint", action: "upsert", project_id: <id>
create_projectscopestack_project_item_write type: "project", action: "upsert" (omit project_id to create)
update_projectscopestack_project_item_write type: "project", action: "upsert", project_id: <id>
update_project_contactscopestack_project_item_write type: "contact", action: "upsert", project_id: <id> (pass the contact id)
update_project_locationscopestack_project_item_write type: "location", action: "upsert", project_id: <id> (pass the location id)
update_project_productscopestack_project_item_write type: "product", action: "upsert", project_id: <id> (pass the product id)
update_project_resource_ratescopestack_project_item_write type: "resource_rate", action: "upsert", project_id: <id> (pass the resource_rate id)
update_project_servicescopestack_project_item_write type: "service", action: "upsert", project_id: <id>, project_service_id: <id>
update_project_surveyscopestack_project_item_write type: "survey", action: "upsert", project_id: <id>, survey_id: <id>
get_service_usagescopestack_list_settings model: "services", id: <task_id>, response_format: "usage"
list_blueprintsscopestack_list_settings model: "blueprints" (response_format: "full" for items)
list_document_templatesscopestack_list_settings model: "document-templates" (pass filters: {"project_id": <id>} + response_format: "full" for the per-project filename)
list_payment_termsscopestack_list_settings model: "payment-terms"
list_phasesscopestack_list_settings model: "phases" (response_format: "full" for position/default). This is the account’s standard phase list from Settings, which list_phases returned. For the phases on one project, use scopestack_list_project_items type: "phases", project_id: <id>.
list_project_udfscopestack_list_settings model: "project-udf"
list_questionnairesscopestack_list_settings model: "questionnaires"
list_rate_tablesscopestack_list_settings model: "rate-tables"
list_resource_ratesscopestack_list_settings model: "resource-rates" (pass filters: {"rate_table_id": <id>} to scope to one table)
list_sales_executivesscopestack_list_settings model: "sales-executives"
list_service_categoriesscopestack_list_settings model: "service-categories" returns a flat list. With response_format: "full" each category carries its parent_id and line of business, and you can filter by parent_id. The nested category tree, the line_of_business input and include_services have no replacement.
search_clientsscopestack_list_settings model: "clients" (omit query to list all)
search_productsscopestack_list_settings model: "products"
search_service_categoriesscopestack_list_settings model: "service-categories"
search_servicesscopestack_list_settings model: "services"
search_vendorsscopestack_list_settings model: "vendors"
settings_get_questionnairescopestack_list_settings model: "questionnaires", id: <id-or-slug>, response_format: "detail"
settings_create_questionnairescopestack_settings_write model: "questionnaire", action: "upsert" (omit id to create)
settings_create_sales_executivescopestack_settings_write model: "sales_executive", action: "upsert" (omit sales_executive_id to create)
settings_create_servicescopestack_settings_write model: "service", action: "upsert" (omit service_id to create). Accepts languages for the service and each nested subservice.
settings_create_service_categoryscopestack_settings_write model: "service_category", action: "upsert"
settings_update_blueprintscopestack_settings_write model: "blueprint", action: "upsert" (pass blueprint_id); action: "delete" to remove
settings_update_questionnairescopestack_settings_write model: "questionnaire", action: "upsert" (pass the id to update)
settings_update_sales_executivescopestack_settings_write model: "sales_executive", action: "upsert" (pass sales_executive_id); action: "delete" to deactivate
settings_update_servicescopestack_settings_write model: "service", action: "upsert" (pass service_id); action: "delete" to remove. Upserts accept languages.
settings_update_subservicescopestack_settings_write model: "subservice", action: "upsert" (pass subservice_id); action: "delete" to remove. Upserts also accept languages entries with field and value.
update_service_languagescopestack_update_service_language (same arguments)
tool_guidancescopestack_tool_guidance

For catalog language, call scopestack_settings_write with action: "upsert" and model: "service" or model: "subservice". Supply a languages array of {field, value} entries. Get active field keys from permitted_language_fields in scopestack_tool_guidance. Send the description separately as service_description.

Service creation accepts language for the top-level service and for each entry in subservices. A successful create returns ignored keys from both levels in one ignored_fields list, if any. Updates preserve omitted keys and report ignored ones on success. A language-only update with no valid keys returns an error. To read permitted, nonblank language for both levels, use scopestack_list_settings with model: "services" and response_format: "full".

Superseded tools

These tools have been removed. The tables below record what each one did, for reference when you translate an older call.

Project Core

ToolWhat it doesRequired inputsReads/Writes
create_projectCreate a new project, optionally with a client, rate table, service location, and user-defined field values.project_nameWrites
get_projectReturn the full contents of a project: services, resources, products, financials (hours, revenue, cost, margin), and narrative fields.project_idReads
update_projectUpdate project metadata: name, narrative summaries, MSA date, presales engineer, sales executive, and user-defined fields while the project is Building. Send status changes separately through workflow actions.project_idWrites
search_projectsSearch projects by name, summary, client, presales engineer, sales executive, business unit, line of business, status, tags, or date ranges (created_after, created_before, approved_after, approved_before; use YYYY-MM-DD or an ISO8601 timestamp). Each project in the results includes submitted_at and approved_at. approved_at is set only when the approval workflow completes, so it is empty on a project that never went through approval, and the approved date filters leave such projects out. Returns only active (non-archived) projects by default. Pass the optional active input to change that: true for active only, false for archived only, all for both.noneReads
review_project_scopeRun a best-practice completeness check on a project’s SOW and return a scored report (language coverage, structure, level-of-effort sanity, content quality, placeholders).project_idReads

Project metadata, scope, and service language edits through the current MCP tools require Building status. Send a changed status on its own with scopestack_project_item_write, type: "project", action: "upsert", and the project_id. Use technical_approval to request approval and building to cancel an active approval request or re-scope an approved, won, or lost project. Re-scoping withdraws approval, so confirm before doing it; the project will need approval again. The approval workflow sets approved, sales_approval, business_approval, and canceled; these cannot be assigned directly.

Services & SOW Language

ToolWhat it doesRequired inputsReads/Writes
add_service_to_projectAdd a catalog or custom service (and optional subservices) to a project.project_id, quantity, project_resource_id, service_category_idWrites
update_project_serviceUpdate or remove a project service, and create, update, or delete its subservices.project_service_idWrites
update_service_languageSet SOW language (deliverables, assumptions, out-of-scope, etc.) and/or the service description on a service or subservice.project_id, plus one of project_service_id or project_subservice_idWrites

For language on a project service or subservice, call scopestack_update_service_language with project_id and either project_service_id or project_subservice_id. This requires Manage on SOW Language. Send text fields in languages using the account’s active keys, and set the description separately with service_description. Use scopestack_project_item_write for changes to service structure, such as hours, quantity, phase, or resource.

Resources & Rates

ToolWhat it doesRequired inputsReads/Writes
add_resource_rate_to_projectAdd a billable resource role from the account’s rate table to a project.project_id, resource_rate_idWrites
add_vendor_resource_to_projectAdd a vendor resource to a project with a role, bill rate, and cost rate.project_id, vendor_id, vendor_role, hourly_rate, hourly_costWrites
update_project_resource_rateUpdate the bill rate and/or cost rate for a resource already on a project.project_id, project_resource_idWrites
list_project_resourcesList all resources (roles and vendors) assigned to a project.project_idReads
list_rate_tablesList rate tables available for the account, including archived ones. Its replacement, scopestack_list_settings model: "rate-tables", returns active tables only unless you pass active: "archived" or active: "both".noneReads
list_resource_ratesList the resource rates within a rate table. With scopestack_list_settings model: "resource-rates", the active input has no effect, so scope to active tables with the rate_table_id filter.rate_table_idReads
get_service_usageReturn usage stats for a catalog service: project count, active deployments, last used, blueprint memberships, recent projects.task_idReads

Products

ToolWhat it doesRequired inputsReads/Writes
add_product_to_projectAdd a product from the catalog to a project by material ID and optional quantity.project_id, material_idWrites
update_project_productUpdate the quantity of a product on a project, or remove it.project_product_idWrites
search_productsSearch the product catalog by name or SKU to find the material ID.queryReads

Locations

ToolWhat it doesRequired inputsReads/Writes
add_project_locationAdd a named service location (on-site address or remote) to a project.project_id, nameWrites
update_project_locationUpdate the name, address, or remote flag of a location.project_id, plus one of location_id or location_nameWrites
list_project_locationsList all service locations on a project.project_idReads

For a multi-site project, first call scopestack_list_project_items with type: "locations" and project_id. Find the installation site’s ID. To assign an existing service at that site, call scopestack_project_item_write with inputs like these:

{ "type": "service", "action": "upsert", "project_id": "123", "project_service_id": "456", "project_location_id": "789" }

You can also use project_location_id when creating a service. The location must belong to the service’s project.

Project Contacts

ToolWhat it doesRequired inputsReads/Writes
list_project_contactsList the active contacts on a project, including each contact’s role (contact_type).project_idReads
add_project_contactAdd a contact to a project, such as the primary customer contact. Setting a primary contact regenerates document previews automatically.project_id, name, contact_typeWrites
update_project_contactUpdate an existing project contact’s details or role. Changing the primary contact regenerates document previews automatically.project_contact_idWrites

Pricing Adjustments

ToolWhat it doesRequired inputsReads/Writes
add_price_adjustment_to_projectAdd a discount, markup, or fee to a project, optionally scoped to a section or resource.project_idWrites

Surveys & Questionnaires (on a Project)

ToolWhat it doesRequired inputsReads/Writes
apply_questionnaire_to_projectInstantiate a questionnaire as a survey, write answers, build recommendations, and apply the resulting services — in one call.project_id, questionnaire_idWrites
list_project_surveysList the surveys on a project, including questions and existing answers.project_idReads
update_project_surveyWrite answers to a project survey; by default marks it complete and sends notifications.project_id, survey_id, responsesWrites
list_questionnairesList published questionnaires available for the account.noneReads

Documents

ToolWhat it doesRequired inputsReads/Writes
list_document_templatesList document templates available for a project.project_idReads
get_project_document_statusGet a project document’s generation status, and its download URL when you pass response_format: "detailed".project_document_idReads

To generate a document, your role needs Create or higher on Project Overview. To check status and download, you need View or higher.

  1. Call scopestack_project_item_write with type: "document", action: "upsert", project_id, and document_type. For sow, pass the document template ID as template_id. Find it with scopestack_list_settings and model: "document-templates". For report, pass the custom report ID. Omit template_id for pricing, breakdown, or autotask.
  2. Poll scopestack_list_project_items with type: "document_status" and the returned project_document_id. When the status is finished or generated, fetch the file. If generation fails, the tool returns the generation error.
  3. In a client that supports MCP resources, read scopestack://projects/{project_id}/project-documents/{project_document_id} for the file bytes. Otherwise, repeat the status call with response_format: "detailed" to get download_url and expires_at. Fetch the file within five minutes. If the link expires, request a fresh one.

Search & Discovery

ToolWhat it doesRequired inputsReads/Writes
search_clientsSearch active clients by full or partial name.nameReads
search_servicesSearch active catalog services by a word or phrase, with an optional service-type filter.contentReads
search_service_categoriesSearch active service categories by name.nameReads
search_vendorsSearch active vendors by name.nameReads

Account Configuration Lists

ToolWhat it doesRequired inputsReads/Writes
list_phasesList active project phases for the account.noneReads
list_payment_termsList active payment terms for the account.noneReads
list_project_udfList project-level user-defined fields configured for the account.noneReads
list_service_categoriesList the catalog hierarchy of Lines of Business and the service categories nested beneath them. Omit line_of_business to list every LOB.noneReads
list_sales_executivesList the account’s sales executives, available for assignment to projects. Defaults to active only.noneReads

Blueprints

ToolWhat it doesRequired inputsReads/Writes
list_blueprintsList all blueprints available for the account.noneReads
apply_blueprint_to_projectApply a blueprint to a project, adding its pre-built services and resources.project_id, blueprint_idWrites
create_blueprint_from_projectCreate a reusable blueprint from an existing project’s scope.project_id, nameWrites

Settings — Catalog & Questionnaires

ToolWhat it doesRequired inputsReads/Writes
settings_create_serviceCreate a standard service (with optional subservices and SOW language) in the catalog.name, service_category_idWrites
settings_update_serviceUpdate a catalog service’s name, description, category, hours, or language; set delete: true to deactivate it.service_idWrites
settings_update_subserviceUpdate a catalog subservice’s name, description, hours, or language using languages entries with field and value; set delete: true to deactivate it. Use permitted_language_fields from scopestack_tool_guidance for valid keys; successful updates report ignored keys in ignored_fields.subservice_idWrites
settings_create_service_categoryCreate a service category or nested subcategory.nameWrites
settings_create_questionnaireCreate a questionnaire with questions, sections, calculations, and service recommendations.nameWrites
settings_update_questionnaireAppend questions, sections, calculations, or recommendations to a questionnaire; optionally update its name or intro.idWrites
settings_get_questionnaireFetch a single questionnaire’s full detail by ID or slug.idReads
settings_update_blueprintUpdate a blueprint’s name, add or remove service items, or delete it.blueprint_idWrites
settings_create_sales_executiveCreate a sales executive on the account so they can be assigned to projects.nameWrites
settings_update_sales_executiveUpdate a sales executive’s details, or remove them from the account with active: false.sales_executive_idWrites

Utility

ToolWhat it doesRequired inputsReads/Writes
tool_guidanceReturn the recommended workflow, key concepts, and common flow sequences for the MCP tools. A good first call in a session.noneReads

New to ScopeStack?

ScopeStack automates scoping, pricing, and SOW generation for IT services teams. See how it fits your process.

Book a demoBrowse the docs
Last updated on