Guides
Guides

Tools

Everything the connector can do, grouped by area.

This page lists everything the connector can do. You do not call these directly. You ask your assistant for what you want, and it picks the right one.

Legend:

  • 🟢 Read returns information and changes nothing.
  • 🟠 Change updates configuration or records in a registered sandbox org.
  • 🔵 Run runs Apex tests in a registered sandbox org without changing its configuration.
  • ⚙️ Utility does not touch your nCino environment.

What needs an org, and what does not

Releases and packages, Schema, and Knowledge work without any org connected. They read nCino's own catalogs and documentation, so they are available as soon as your assistant is connected. The one exception is analyze_installed_packages, which reads the packages installed in one of your orgs.

Salesforce configuration and Apex tests act on one of your orgs and need one registered. Ask your assistant to list your registered sandbox orgs and it returns each one with its connection status. Choose one, and it uses that org for the rest of the request.

Only registered sandbox orgs are reachable. Production orgs cannot be registered or targeted. If an org is missing or shows a failed status, see Limitations and contact your Customer Success Manager.

Admin tools

Salesforce configuration

The change tools are off by default. Your institution can ask to have them turned on. See Limitations.

ToolAccessWhat it does
list_sandbox_orgs🟢 ReadLists your registered sandbox orgs and their connection status. Start here.
query_soql🟢 ReadRuns a read-only SOQL query against data in the selected org. Large results come back in pages.
query_tooling🟢 ReadRuns a read-only query against metadata such as Apex classes and custom fields. Large results come back in pages.
search_configuration🟢 ReadQueries an object by combining fields and filters, without writing SOQL.
get_apex_class🟢 ReadReturns Apex class details, optionally including the source.
get_apex_trigger🟢 ReadReturns Apex trigger details, optionally including the source.
get_flow_metadata🟢 ReadReturns Flow details, filterable by name, type, or status.
get_validation🟢 ReadReturns an object's validation rules with their error messages and status. Name a rule to also get its formula.
get_approval🟢 ReadReturns approval process definitions for an object.
get_flexipage🟢 ReadReturns Lightning page layout details.
get_list_views🟢 ReadReturns the list views defined for an object.
get_picklist_values🟢 ReadReturns a picklist field's active values and its default. Where record type assignments are requested, also reports inactive values still assigned to a record type. Inactive values are otherwise visible only in Setup.
get_packages🟢 ReadReturns installed managed packages and their versions.
get_debug_logs🟢 ReadReturns recent debug logs, filterable by user, operation, and time.
get_system_properties🟢 ReadReads nFORCE or LLC_BI system properties. Categories and keys are case-sensitive.
get_feature_flag_status🟢 ReadReturns whether nFORCE feature flags are on or off.
metadata_retrieve🟢 ReadReads the full metadata definition of components such as security settings, remote site settings, page layouts, and permission sets, including settings that queries can't reach. Up to 10 components per request.
manage_feature_flags🟠 ChangeTurns nFORCE feature flags on or off, including parent and child flags.
manage_system_properties🟠 ChangeCreates, updates, or deactivates nFORCE or LLC_BI system properties. Up to 50 per request.
metadata_deploy🟠 ChangeCreates or updates declarative metadata, such as picklist values, page layouts, permission sets, profiles, remote site settings, and custom metadata. By default, changes are merged into the existing definition. Up to 50 components per request.
record_upsert🟠 ChangeCreates or updates records on any object the nCino Communicator user can edit, including permission set assignments. Up to 200 records per request.

Apex tests

ToolAccessWhat it does
run_apex_tests🔵 RunStarts a run of your own Apex test classes or suites, or of all local tests. Test data is rolled back. Runs count toward the org's daily limit on queued test classes.
get_apex_test_results🟢 ReadReturns a test run's progress or its result: pass and fail counts, failure messages, and stack traces.
get_apex_code_coverage🟢 ReadReturns Apex code coverage for each class and trigger, plus the org-wide total, and flags anything under 75%.

Releases and packages

All read-only. Installing a release is not available through the connector, and continues to go through your existing process with your Support Release Manager.

ToolAccessWhat it does
search_releases🟢 ReadSearches generally available nCino releases by name, type, or classification.
get_release_details🟢 ReadReturns a release's full details, including its package versions.
analyze_installed_packages🟢 ReadMaps an org's installed packages to nCino releases. Shows the release the org is on and any packages from other releases, and can compare the org against a target release.
build_upgrade_path🟢 ReadBuilds the ordered upgrade path between two releases, including milestone releases, skipped months, and links to release notes and installation guides.
search_packages🟢 ReadSearches nCino packages by name, alias, namespace, or generation.
search_package_versions🟢 ReadSearches generally available package versions.
get_package_version_details🟢 ReadReturns a package version's details and its dependency tree.
resolve_package_dependencies🟢 ReadWorks out install order, detects conflicts, and includes transitive dependencies.

Schema

ToolAccessWhat it does
resolve_schema🟢 ReadReturns field details for an nCino or Salesforce object, including types, picklist values, and relationships.
compare_releases🟢 ReadCompares an object's schema between two releases: fields added, removed, or changed.
find_references🟢 ReadFinds every object that points at a given object. Useful for impact analysis.
resolve_metadata_schema🟢 ReadReturns the valid fields for a metadata type, such as Layout or PermissionSet, including required fields and allowed values.

Knowledge

Searches return ranked results. Use the article tools to pull the full text of a specific article.

ToolAccessWhat it does
search_help_documentation🟢 ReadSearches help articles and Known Issues (PDIs). Known Issues can be filtered by feature and release.
get_help_article_content🟢 ReadReturns a help article or PDI in full.
search_technical_documentation🟢 ReadSearches technical docs by type: How to Configure, How to Use, Release Notes, or Installation Guide.
get_technical_documentation_article🟢 ReadReturns a technical documentation article in full.

Feedback

ToolAccessWhat it does
submit_feedback⚙️ UtilitySends feedback to the team that maintains the connector. Changes nothing in your environment.

Did this page help you?