• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Developer toolchainPalantir MCPAvailable tools

    Available tools

    Palantir MCP provides tools for working with Foundry resources, data, code, and documentation. The tables below list the tools and their availability in local development and Code Workspaces.

    Tool availability

    The Local development column applies to Palantir MCP running on your machine. The Code Workspaces column applies to Palantir MCP running inside Foundry:

    • Yes: The tool is enabled in that environment. In Code Workspaces, it is enabled for all repository and workspace types.
    • No: The tool is not enabled in that environment. Tools with Yes for local development and No for Code Workspaces are local-only.
    • A named repository or workspace type: The tool is enabled only for that type in Code Workspaces.
    • System prompt: Relevant context is included automatically for the repository type, without a tool call. This does not mean the tool itself is callable. OSDK context applies to OSDK and OSDK widget repositories; ML documentation applies to model training and model adapter repositories.

    The repository-specific labels mean the following:

    • Python transforms: Python transforms repositories, including model training repositories
    • Python compute modules: Python compute module repositories
    • Function and agent repositories: Python functions, TypeScript v1 and v2 functions, and TypeScript pro-code agent repositories
    • Jupyter and RStudio: Jupyter and RStudio workspaces only

    For setup and permissions, see installation and security.

    Compass tools

    Tool nameDescriptionLocal developmentCode Workspaces
    list_resources_in_foundry_folderReturns resources available in a given folder or project RID, with pagination support.YesYes
    get_project_importsReturns datasets and other resources imported into a Foundry project, including external resources such as Spark profiles, with pagination support.YesYes
    list_foundry_namespacesLists all Foundry namespaces that you can access.YesNo
    list_foundry_project_templatesLists available project templates for a Foundry namespace. Templates define the initial structure and settings for new projects.YesNo
    create_foundry_projectCreates a new Foundry project in a specified namespace using a specified template.YesNo
    search_foundry_projectsSearches for Foundry projects by name or description. Returns matching projects with their RID, name, description, and path.YesNo
    search_foundry_resourcesSearches for datasets, folders, code repositories, and other resources by name, description, or path. Supports filtering by resource type, project, or namespace. Use search_foundry_projects to find projects.YesNo
    move_foundry_resourcesMoves resources into another folder within the same project. Does not support moving projects or moving resources between projects.YesNo

    Dataset tools

    Tool nameDescriptionLocal developmentCode Workspaces
    get_foundry_dataset_schemaReturns the definition of a Palantir dataset for a given dataset RID or dataset path, including schema information.YesYes
    run_sql_query_on_foundry_datasetReturns the result of running a SQL query on a Palantir dataset on an optional branch.YesYes
    create_and_write_to_foundry_datasetCreates a dataset in Foundry with data provided from a CSV file, useful for uploading local data or creating mock data.YesYes
    list_dataset_filesLists the files in a Foundry dataset for a given dataset RID or dataset path. Useful for exploring datasets without a schema.YesYes
    build_datasetsBuilds datasets in Python transforms repositories. Commit and push changes before submitting a build.YesPython transforms
    get_build_statusReturns the build status of CI checks or dataset builds. Supports checking by build RID, tag, or branch.YesYes
    search_dataset_buildsSearches for historic builds based on criteria such as dataset RIDs, build statuses, branches, and time ranges.YesYes
    get_job_statusRetrieves detailed status information for a specific job by job RID, including error messages and source code information.YesYes
    get_dataset_statsReturns size and file statistics for a Foundry dataset, including total size, number of files, hidden files, and number of transactions.YesYes

    Media tools

    Tool nameDescriptionLocal developmentCode Workspaces
    get_media_setReturns a media set's configuration, including its primary media schema and additional allowed input formats.YesYes
    get_media_item_metadataReturns structural metadata for a media item, such as its format, dimensions, duration, or page count, without returning the file content.YesYes
    list_media_itemsLists media items with their RIDs, paths, MIME types, and retention-expiration timestamps, with pagination support.YesYes
    add_media_set_allowed_input_schemaAdds an allowed input format to a media set so it accepts uploads in that format.YesNo
    remove_media_set_allowed_input_schemaRemoves an additional allowed input format from a media set. Existing media items are unaffected.YesNo

    Data health tools

    Tool nameDescriptionLocal developmentCode Workspaces
    manage_health_checkCreates, updates, or deletes health checks on Foundry datasets.YesYes
    get_health_check_infoLists health checks, retrieves their configurations and latest reports, and discovers which datasets have checks configured.YesYes
    get_available_check_typesLists available health check types and their supported validations.YesYes
    manage_check_groupCreates or updates health check groups and manages check membership in groups and monitoring views.YesYes
    get_check_group_infoLists accessible health check groups or retrieves a group's checks, notification schedule, and configuration.YesYes
    manage_check_statePauses or resumes health checks, or retrieves their pause status.YesYes

    Data Lineage tools

    Tool nameDescriptionLocal developmentCode Workspaces
    get_resource_graphReturns the resource graph for data lineage visualization.YesNo

    Ontology tools

    Tool nameDescriptionLocal developmentCode Workspaces
    get_foundry_ontology_ridFetches the ontology RID for a given Foundry OSDK application or local repository.YesSystem prompt
    search_foundry_ontologySearches the Ontology for relevant entities for a given query.YesYes
    search_foundry_functionsSearches the function registry for functions matching a query.YesYes
    view_foundry_object_typeDisplays an existing object type in the Ontology, including its properties, link types, and action types.YesYes
    create_or_update_foundry_object_typeCreates or updates object types in the Ontology on a provided branch.YesYes
    delete_foundry_object_typeDeletes an object type from the Ontology on a provided branch.YesYes
    view_foundry_link_typeDisplays an existing link type in the Ontology.YesYes
    create_or_update_foundry_link_typeCreates or updates link types in the Ontology on a provided branch.YesYes
    delete_foundry_link_typeDeletes a link type from the Ontology on a provided branch.YesYes
    view_foundry_action_typeDisplays an existing action type in the Ontology, including its parameters, logic rules, and dependent object types.YesYes
    create_or_update_foundry_action_typeCreates or updates action types in the Ontology on a provided branch. Supports object modifications, deletions, and link operations.YesYes
    delete_foundry_action_typeDeletes an action type from the Ontology on a provided branch.YesYes

    Object set tools

    Tool nameDescriptionLocal developmentCode Workspaces
    query_ontology_objectsQueries ontology objects based on specified criteria with pagination support.YesNo
    aggregate_ontology_objectsPerforms aggregation functions on object fields, supporting grouping, filtering, and multiple aggregation types.YesNo
    semantic_searchFinds ontology objects similar to a natural-language query using a vector embedding property and its configured embedding model. Returns matches ordered by similarity.YesNo

    OSDK tools

    Tool nameDescriptionLocal developmentCode Workspaces
    get_ontology_sdk_contextFetches curated documentation about the Ontology SDK for your OSDK repository.YesSystem prompt
    get_ontology_sdk_examplesRetrieves code examples for using the Ontology SDK, filtered by SDK version and topic.YesYes
    create_or_update_ontology_sdk_versionCreates or updates an OSDK by publishing a new version with the specified ontology entities. Supports Developer Console applications and standalone SDK packages.YesYes
    install_sdk_packageChecks SDK package generation status and provides installation instructions when ready. Supports Developer Console applications and standalone SDK packages.YesYes

    Platform SDK tools

    Tool nameDescriptionLocal developmentCode Workspaces
    list_platform_sdk_apisLists available Platform SDK APIs for a given Foundry product.YesYes
    get_platform_sdk_api_referenceGets API reference documentation and code examples for Platform SDK API endpoints.YesYes

    Code Repository tools

    Tool nameDescriptionLocal developmentCode Workspaces
    get_repository_contextFetches curated context about the current Foundry code repository, including project and ontology information.YesYes; system prompt
    create_python_transforms_code_repositoryCreates a new Python transforms code repository.YesNo
    clone_code_repository_locallyClones an existing Foundry code repository to a local directory.YesNo
    create_code_repository_pull_requestCreates a pull request in a Foundry code repository.YesYes
    list_code_repository_pull_requestsLists pull requests for a Foundry code repository with filtering by status, branch, author, and title.YesYes
    get_code_repository_pull_requestGets pull request details, including review status, CI build status, file changes, and comments.YesYes
    create_code_repository_pull_request_commentCreates a comment on a Foundry code repository pull request. Supports general comments and inline comments anchored to a specific file and line.YesYes
    publish_functionPrepares a release of a function or pro-code agent repository by selecting a semantic version and returning Git commands to create and push the release tag. Requires a clean working tree; publication completes through CI after the commands run.YesFunction and agent repositories

    Code Workspaces tools

    Tool nameDescriptionLocal developmentCode Workspaces
    get_foundry_environment_declared_data_scopeLists dataset, table, and restricted-view aliases declared for the current workspace, with import snippets where supported. Does not enumerate OSDK data scope.NoJupyter and RStudio

    Global Branching tools

    Tool nameDescriptionLocal developmentCode Workspaces
    create_global_branchCreates a new global branch with a specified display name and description.YesYes
    view_global_branchDisplays an existing global branch, including branched resources and ontology modifications.YesYes
    close_global_branchCloses an existing global branch.YesYes
    create_global_proposalCreates a proposal for changes on a global branch.YesYes
    view_global_proposalDisplays an existing proposal and contextual information based on its status.YesYes
    close_global_proposalCloses an existing proposal without merging it.YesYes

    Developer Console tools

    Tool nameDescriptionLocal developmentCode Workspaces
    connect_to_dev_console_appConnects a non-Foundry Git repository to a Developer Console application.YesNo
    convert_to_osdk_reactConverts an existing OSDK application to use @osdk/react with OsdkProvider2 and optionally @osdk/react-components.YesYes
    view_osdk_definitionFetches a high-level overview of the OSDK definition, including object types, link types, action types, and functions.YesYes

    Compute module tools

    Tool nameDescriptionLocal developmentCode Workspaces
    get_compute_modules_documentationFetches curated documentation about compute modules and the compute_modules Python SDK.YesPython compute modules
    get_compute_modules_infoGets status and configuration for a compute module, including runtime status, scaling configuration, and runtime parameters.YesNo
    get_compute_modules_logsRetrieves the latest logs for a compute module by build job RID, with pagination support.YesNo
    manage_compute_modulesManages a compute module lifecycle: start, stop, or configure development mode for automatic upgrades.YesNo
    execute_compute_modules_functionExecutes a compute module function synchronously. Only works with compute modules running in FUNCTION mode.YesNo

    Data Connection tools

    Tool nameDescriptionLocal developmentCode Workspaces
    create_foundry_rest_api_data_sourceCreates a REST API data source connection in Foundry for integrating with external systems.YesNo
    create_foundry_rest_api_data_source_webhookCreates a webhook for a REST API data source in Foundry.YesNo
    update_foundry_rest_api_data_source_webhookUpdates an existing webhook in Foundry by publishing a new version with an updated specification.YesNo
    view_foundry_rest_api_data_source_webhookFetches the latest version of an existing webhook in Foundry, including its metadata, specification, inputs, calls, and outputs.YesNo
    get_or_create_network_egress_policyGets or creates a network egress policy in Foundry. Useful when creating REST API data sources and webhooks.YesNo

    Documentation search tools

    Tool nameDescriptionLocal developmentCode Workspaces
    get_python_transforms_documentationFetches curated documentation about Python transforms and the transforms.api SDK.YesPython transforms; system prompt
    get_typescript_v1_functions_documentationRetrieves documentation and code snippets for TypeScript v1 function repositories.YesSystem prompt
    get_typescript_v2_functions_documentationRetrieves documentation and code snippets for TypeScript v2 function repositories.YesSystem prompt
    get_custom_widget_documentationGets documentation for custom widgets, including React widgets for Workshop and Slate.YesSystem prompt
    get_ml_documentationFetches ML documentation for Python transforms, covering model training, MLOps, and framework-specific patterns.YesPython transforms; system prompt
    get_spark_profile_documentationFetches documentation on Spark profile configuration for Python transforms, including guidance for selecting executor memory, number of executors, and driver settings.YesPython transforms
    get_osdk_react_components_documentationGets documentation for the @osdk/react-components library, including ObjectTable and other pre-built components.YesYes
    load_foundry_documentation_pageLoads a full Palantir Foundry documentation page by its path and returns the complete page content in Markdown format.YesYes
    get_documentation_summariesRetrieves a curated documentation summary bundle for a specific Foundry topic area, covering key concepts, patterns, and reference material.YesYes
    search_foundry_documentationSearches Palantir Foundry platform documentation indices for relevant context snippets for a given query. Requires AIP.YesYes

    Tool discovery

    The search_tools tool is registered separately from the other tools and is opt-in in both environments. When tool search is enabled, only search_tools is initially visible. It discovers and activates tools permitted by your environment and configuration; it does not enable local-only tools in Code Workspaces. Your MCP client must support dynamic tool-list updates.

    Tool nameDescriptionLocal developmentCode Workspaces
    search_toolsFinds and activates tools for a specific task using a natural-language query.Opt-inOpt-in