Swantide Prompting & User Guide
Last Updated: 10/7/2025
Scope
This document outlines the scope, features and functionality of the Swantide platform. This includes the Swantide AI Assistant, AI Documentation (also known as Data Dictionary), and AI Admin.
Swantide has access to Salesforce metadata only - we use the Metadata API and Tooling API to pull down metadata components from the Salesforce org connected to Swantide. This means that the following items are out of scope:
Anything outside of Salesforce
Anything in Salesforce but not on Core (e.g. legacy Marketing Cloud)
Record-level data in Salesforce
You can check the Salesforce Metadata Coverage report for more information on what is and isn’t Salesforce metadata, or use the Swantide data dictionary to find the metadata that you are looking for. See the table below for common metadata components and notes about how to approach them with Swantide:
Metadata Type | Notes |
CustomObject | Objects are Salesforce metadata; note that Salesforce uses the CustomObject metadata type to apply to both standard objects (e.g. Account) and custom objects. The object itself and its fields are Salesforce metadata; the records themselves are not.
You can use the Salesforce metadata to troubleshoot or understand specific things on records. For example, if you are trying to understand why certain records are not appearing in reports, Swantide can see things like the report filters and report types, and provide suggestions of potential things to troubleshoot, but it does not have access to the specific recordID in question. |
CustomField | Fields are also Salesforce metadata; note that Salesforce uses the CustomField metadata type to apply to both standard and custom fields |
Report | Reports are Salesforce metadata. You can see the report name, type, filters, as well as visible columns as Salesforce metadata. As mentioned above, you can use these things to troubleshoot why records are not showing up in certain reports, but the records themselves are not visible to Swantide |
Flow | Flows are Salesforce metadata. As part of the metadata Swantide can also see any call outs to sub-flows or apex classes |
Apex Class | Apex classes are Salesforce metadata; note that Swantide can see the same things that you can see in the org. This means that apex code that is protected as part of a managed package is not visible in Swantide |
Validation Rule | Validation rules are Salesforce metadata; you can see the name, error condition formula, and message. A common use case of the Swantide AI Assistant is inputting an error message generated by a validation rule and asking for guidance on how to avoid the error condition |
Profile | Profiles are Salesforce metadata, and can be used alongside permission sets to troubleshoot user related issues, as users are records and not Salesforce metadata (see below for more information); however, note that profiles in Salesforce store a huge amount of information, including access to all classes, layout assignments, objection permissions, and tab visibilities. Most profiles have thousands or tens of thousands of individual settings on them.
This makes it challenging to compare and contrast profiles holistically in a digestible way. Swantide is good at answering targeted questions (e.g. what permissions does Profile X have on object Y). Broader prompts (e.g. compare and contrast all profiles in this org) are more challenging to get a concise and useful answer. Be sure to use targeted prompts when asking about profiles and permission sets |
Permission Set | Permission sets are similar to profiles, in that they are Salesforce metadata and store a substantial amount of information (albeit less than profiles). Be sure to use targeted prompts when asking about profiles and permission sets |
Users | Users are not Salesforce metadata, they function as record-level data. If you need to troubleshoot why users are unable to do certain things in Salesforce, you can start by analyzing things that are metadata which are associated with users, such as profiles and permission sets |
How to Connect an Org to Swantide
Here are the steps for connecting an org to Swantide:
Send a Slack or email to Swantide informing us that you want to connect a new org. The message should include the name of the org, whether it is a sandbox environment or a Prod/Dev environment, and which users should have access.
Swantide will create the org to house the connection to a Salesforce environment
Follow the steps in this video to install the Swantide managed package
Swantide will automatically ingest all the metadata in the org and the AI will begin documenting the metadata in the org. Please allow 24 - 48 hours after connection to finish documentation.
Also, please note that Swantide generally prices on a per org basis for AI Assistant, Documentation, and AI Admin since we incur costs upfront to document each org. Please consult your contract (or ask Swantide) for the number of orgs you can enable AI Assistant & Documentation
Swantide Platform - Features & Functionality
Documentation
Also referred to as the Swantide Data Dictionary
Search for any metadata component in your org, filtered by metadata component type
For each component, view:
Metadata JSON of the component
Business & Technical descriptions of the component. Documentation can be modified manually or via AI prompt. Note that if the component is updated, the documentation will be re-generated.
Components referenced within that component (e.g. if looking at a flow, what fields are referenced within it). We compile this list by searching through the metadata JSON for the component API names, leveraging AI to identify matches.
Other components that reference a given component, filtered by metadata component type (e.g. all flows that reference Opportunity.StageName). Note that this will show any reference to the component name filtered by metadata component, not other custom filters (e.g. only active flows that update Opportunity.StageName). See the Analysis Section for more information on how to use Swantide for these types of requests.
Change Log that shows the date of prior changes.
On a nightly basis, updates to existing metadata and newly created metadata components sync automatically.
If you need to sync components faster than that, you can manually sync updates at the component level immediately.
AI Assistant
Ask the AI Assistant questions about your Salesforce environment. Expect that:
AI Assistant can retain 10 - 15 metadata components as context in any given thread
For each chat prompt, expect output to be capped at ~ 1 page
Copy/paste the output for use in documents outside of Swantide
Chrome extension to ask questions of the AI Assistant (Note that Chrome extension does not have access to the Data Dictionary)
Start an AI Admin task from an AI Assistant chat
Hubbl integration: For Recommendations and Object Automation surfaced in Hubbl, copy/paste a prompt to the AI Assistant. Swantide AI Assistant will instruct you on how to address the issue.
Common use cases of AI Assistant include:
Asking questions about specific metadata components
Pre-Sales Analysis
Discovery & Time Estimates
Solution Design (e.g. User stories, technical design documents)
Writing code (e.g. apex, validation rules, formula fields)
Test scripts
Debugging unexpected behavior
Enablement documentation
Asking questions about relationships between objects
Out of Scope
Record-level data in Salesforce. We only access Salesforce metadata.
File uploads (everything must be defined within the prompt). This also means that if you are on a page in a data dictionary and want to ask the AI Assistant for more information, you still need to reference the metadata component as part of the prompt.
For questions about change log, AI Assistant has access to documentation of prior versions for the last 90 days. You can ask the AI Assistant what changed across those versions and it will summarize the changes for you.
Mass export of documentation (although we do support copy/paste)
URLs
AI Admin (Beta)
Define a task you need to complete in Salesforce. Swantide will generate a technical design document along with a list of proposed metadata creates and updates
Review and give feedback on the design at the TDD level and at the individual component level. Can do this via prompt or in-line editing.
Once approved, deploy metadata to Salesforce. If there are errors, see error message returned from Salesforce APIs.
Revert deploy button for updates only (AI Admin does not perform any delete functions; we revert updates by restoring the old version)
Out of Scope in Beta
Updates to extremely large components (e.g. large Profiles)
APEX, LWC creation (suggest using AI Assistant to generate this code)
Security, Permissioning & Profiles
SSO supported through Google (Microsoft only supported for personal accounts)
For non-Google emails, passwordless login enforced via verification code sent to email
Swantide handles creation and assignment of all users. Users are able to toggle between orgs that they have access to (e.g. from sandbox to prod)
There is a 1:1 relationship between Swantide instance and Salesforce instance. All Swantide products retain metadata context only in the Salesforce instance associated with the Swantide instance
Users can be granted access to only certain Swantide instances (e.g. only production, only sandbox, or both)
AI Assistant & AI Admin can be turned on/off at the Swantide instance level
Swantide Use Cases & Prompting Guide
Discovery
Discovery Sessions, PRD, Epics, Features, Stories, AC
Discovery
The documentation in Swantide is a great asset for assisting with discovery. To learn about how a certain object has been set up, find the object in the data dictionary, view the business and technical descriptions, and view the referenced metadata components. See this video for guidance on how to navigate the Swantide data dictionary and AI Assistant to analyze objects.
You can also use the AI Assistant to ask questions about how the org is currently set up. For example: “We are working on a project to optimize the workflow in this org related to renewals. We are hosting a workshop with business and technical stakeholders next week. Help me build a list of discovery questions to guide the workshop”
You may want to refine the prompt further if you want the Assistant to focus on specific components. For example: “We are working on a project to optimize the workflow in this org related to renewals. We are hosting a workshop with business and technical stakeholders next week. Help me build a list of discovery questions to guide the workshop. Focus your questions around renewal automations and the tracking of expansion revenue”
Note that the questions to the AI Assistant should be targeted - keep in mind that it retains 10 - 15 components as context within a thread. The AI Assistant will not be able to answer questions like ‘tell me about all of the business logic configured on the Account object’. Instead, look at the Account object in the data dictionary, find specific flows, and ask more targeted questions. For example, “Tell me more about the Swantide_Mass_Update_Case_Status flow. How does it relate to the Account object?
User Stories & Acceptance Criteria
You can give the Swantide AI Assistant the requirements and ask it to form a user story with entry criteria.
If you already have a user story, you can ask Swantide to review and identify potential gaps in acceptance criteria.
If you have a user story with entry criteria and acceptance criteria, ask Swantide to write a solution design.
Sample Prompts
“Write me a user story, with entry criteria and acceptance criteria, based on the following feature description: ‘If a lead is created with a personal email domain (e.g. gmail), mark the lead as a low priority lead’
Note that the entry criteria takes into account 2 existing fields in this org - the standard IsPriorityRecord on the lead object, as well as a custom formula field Swantide_Business_Domain__c, which distinguishes between business and personal emails. If you asked this prompt in an org that did not have these fields, or had different fields, the output from Swantide would reference those fields instead.
Business Requirements
Once you have answers to your discovery questions, you can give the outcomes to Swantide and ask it to write documentation in whatever format you desire - business requirements documents, solution design documents, user stories, etc. Consider the following prompt:
“Write me a business requirements document based on the following outcomes:
Business Process Understanding: The renewal process should be the same for new business and upsell opportunities. They should be created immediately after a new business is closed won without exception.
Automation Goals: The newly created renewals should distinguish expansion revenue from ARR
Data Quality & Governance: There should be validation rules on the parent opportunity to ensure accurate contract start dates and end dates
Customization & Flexibility: We should use a new set of stages for renewal opportunities”
Because this is generated using AI, you can use the copy/paste function, paste it in whatever document repository you use, and make modifications or tweaks there directly.
Analysis
Analyze, Solution Design, Swagger, Best Practices
Analyzing Current State of the Org
Swantide’s data dictionary and AI Assistant are a really powerful way to understand the current state of your org. Knowing how the org is configured today is an important first step when building new solutions.
The Swantide data dictionary is a great resource for impact analysis. For every metadata component in your org, you can view business and technical descriptions, a list of metadata components that reference a given component, and a change log.
The list of references in particular is one of our most used features. You can look in the documentation and see all metadata components of a certain type, or find a given metadata component, and see all of the other metadata components that reference it by type.
By looking at the references, you can answer questions like:
What flows touch the Account object, as well as their documentation
What validation rules reference Opportunity Stage, as well as their documentation
Compiling these sorts of lists is often the first step of impact analysis, as well as understanding the current state of the org.
Note: We often see our users wanting to filter the references beyond Salesforce metadata types that references it. Examples include:
Show only the active flows that reference the Account object
Show only the flows that trigger on Account creation
Show only the flows that update Opportunity StageName, not simply reference it.
A common pitfall we see is users asking the AI Assistant directly to compile this list for them. This is a tricky request - Swantide has created documents for every metadata component in the org, as well as version history for the last 90 days. This means that at any time there are tens of thousands to hundreds of thousands of documents Swantide maintains as the context of your org.
When you ask a question, Swantide first identifies the documents needed as context to answer the question. For performance reasons, the Swantide AI Assistant quickly identifies 10 metadata components relevant to answer your question, and uses that as context. Expect the AI Assistant to give you a representative sample rather than an exhaustive list. This is common across LLMs - consider asking ChatGPT to compile a list of every Salesforce Administrator job. It’s not going to be able to analyze and pull every job posting with 1 prompt - rather, it will provide a representative sample.
Therefore, the best way to compile these types of lists currently is to use the data dictionary, which supports filtering by metadata component types, and continue investigation from there. We are about to release a ‘deep research’ function for the AI Assistant that would analyze all of the metadata in your org to answer questions like the ones shown above - when the feature is released, please allow some time for Swantide to complete this analysis.
Sample Prompts & Examples
I need to determine all of the flows that trigger when a Case is created (Note: If you ask this question directly to the AI Assistant, expect to get a representative sample and not an exhaustive list). If you need to get an exhaustive list, follow these steps:
Go to the Documentation tab, which shows all of the metadata components in your org. Find the Case object (note that there will likely be hundreds of components if you just search for Case - make sure you filter to the CustomObject metadata type, then search for Case)
Go to ‘References’, and ‘Components that Reference Case’. Filter this list to the flows, and you will have a list of every flow that references the Case object.
Click into each flow (the fastest way to do this is often clicking into a new tab). Review the documentation of each, including the active/inactive status.
If you have follow up questions after reading the documentation, ask them to the AI Assistant.
See this video for guidance through this example.
Solution Design & Time Estimates
You can also use the Swantide AI Admin to write solution design documents. Imagine we want to take the BRD that was generated previously and view a solution design. You can click ‘Start new AI Admin task’, which copies and pastes the output. Make some minor modifications to the task goal to specify we want Swantide to write a solution design document, and it will write the TDD.
Note that the AI Admin will also propose the specific metadata components to build as part of this. This feature is still in Beta, but we have seen really good results from the technical design document generation
Swantide will also provide time estimates for the tasks created to the AI Admin. The time estimates are reflective of how long it takes to both write the solution and component design documents, as well as doing the actual build in Salesforce.
See this video for guidance.
Best Practices
Swantide can also help you evaluate whether certain components were designed with best practices, and suggest potential enhancements. Consider the following sample prompt: “Assess the Swantide_Create_Swantide_Referral_Contact_Contact_Role_on_Opportunity_Creation flow. Provide recommendations to enhance the flow if there are opportunities to better adhere to best practices or improve the overall performance of the flow”
Swantide is able to provide suggestions for enhancing the performance of the flow. If you have specific best practices you want it to follow or things to optimize, specify that as part of the prompt.
Note: Swantide is not an org diagnostics tool. It is not currently designed to assess the entire org (e.g. review every apex classes and flag the ones that have security vulnerabilities). Swantide’s ‘deep research’ function, currently in beta, is designed to handle queries like this. For now, Swantide is best equipped to answer questions about a more narrow subset of metadata components, like reviewing specific flows or classes and suggesting enhancements
Build
Configure / Code / Unit Tests
The Swantide AI Admin is the best way to generate technical design documents and make updates to Salesforce metadata. The process is described below:
Create Task (Client). Create a task name (for reference purposes only), and write a task description, which will be the prompt handed to the AI Admin
Generate Technical Design (Swantide). Swantide will generate an overall solution design document, as well as list each component to be created/updated, with technical designs of the component as well
Review + Approve TDD (Client). Review the design documents generated by Swantide. You can make inline edits or prompt Swantide to re-generate, both at the solution and component level. You can also view prior versions of the solution design if you are not happy with the updates Swantide makes)
Deploy to Salesforce (Swantide). Once you have approved the design of each metadata component, simply click Deploy, and Swantide will deploy the updated metadata into your Salesforce environment. If there are any errors, Swantide will return the error message provided by the Salesforce API
Validate in Salesforce (Client). Once the change has been deployed, view the deployed metadata components in the org and validate that they were deployed correctly. Swantide will automatically update the data dictionary and write documentation for the newly created components.
See this video for a tutorial of how you can use the AI Admin to make updates in Salesforce. Note that this feature is currently in beta - we have gotten good feedback on the solution design element, and are working on providing more stability in the creation of metadata components as we get ready for the product to be GA.
Notes & Best Practices
Because the AI Admin is in beta, if you are looking to write code (e.g. Apex, validation rules, formula fields), we suggest using the AI Assistant to generate the code, and copy/pasting into the Salesforce environment you are working in.
AI Admin tasks are visible at the org level, meaning all users can view all AI Admin tasks. You can only edit your own tasks - all other tasks are read-only.
The more specific you can be in the prompt, the better. Swantide should be able to handle more general tasks (e.g. take all of the fields in the More Information section on the Lead layout, create them as fields on the opportunity, and update the field mappings), but depending on the volume of fields, you may need to specify the names of the fields you want to create.
Testing (QA + UAT)
UAT Scripts
Swantide is a great way to write UAT scripts for updates you are making in Salesforce. The best use cases are either to 1) ask Swantide to write a UAT script based on a user story or technical design document, or 2) ask Swantide to write a UAT script for a specific metadata components.
Best Practices
Take into consideration the size and scope of what you are writing test cases for, and the rule of thumb that Swantide generates output of approximately 1 page, and refine your prompt accordingly. Imagine you want to write a test script for your Opportunity Closing Flow - if it is a very simple flow, you may be able to simply ask for a test script for the flow. If it is a very complex flow (i.e. handling multiple deal types, updating dozens of fields, triggering other flows), refine your prompt to focus on certain deal types, certain personas, etc.
If you are looking for an output in a specific format, make sure you tell Swantide, the AI Assistant will use your instructions in creating the user story
Sample Prompts
“Write me UAT test scripts based on the following user story {insert user story}, covering each edge case. Please include testing steps to follow, expected results, and classification if it is a positive or negative case.”
“Write me UAT test scripts based on this {insert metadata component type} named {insert metadata name}, covering each edge case. Please include testing steps to follow, expected results, and classification if it is a positive or negative case.”
Apex Test Classes
Swantide is also a great way for writing apex test classes and evaluating apex test classes.
Sample Prompts
“Write me a test class for {insert class name}, and ensure that you have at least 80% code coverage with the test class that you write”
“What % of code coverage does the ‘{insert test class name} provide for the {insert parent class name}? I want you to determine code coverage % by reviewing the lines of code and functions that are covered in the test class, rather than by running an actual test in the Salesforce org itself.
Note that the second sentence may be needed because Swantide does not run actual tests in the org itself, but can provide an estimate of code coverage by looking at the code, function, and methods covered in the class. Expect a ~20% range in output.
Deploy
The Swantide AI Assistant is a chat-interface that takes text as input and provides text as output. The Swantide AI Admin will create or update Salesforce metadata. See the previous Build Section for more information on how the AI Admin works.
Today, Swantide is not a replacement for whatever DevOps processes you use to promote metadata between environments. Think of the Swantide AI Admin as a way to automate the solution design and hands-on-keyboard time in the environment where you build or update new components.
You can however use the Swantide AI Assistant to help you build a deployment plan, see the prompt below for details:
Pre-Deployment
‘I want to take updates to the Organization - Before Save - Update flow and the Funding Award After Save flows and deploy them to production. Can you write a pre-deployment checklist for me? I want to make sure I can account for all dependencies, that I can roll back any changes if I need to, and that the production org is ready for the changes I’m about to make’
Potential Follow Ups
Document changes (ask Swantide to write an overview of specific sections of the flow. You can ask Swantide what changed in the flow)
Example: Help me document what updates were made. In the Funding Award After Save Flow, can you describe in detail how the Signatory Assignment Logic works, and how the email notifications work?
Prepare for Rollback: Ask Swantide how you should approach preparing for rollback
Example: “Can you describe in more detail how I should prepare for rollback as part of the pre-deployment checklist? What exactly should I be doing?” This will provide more information about this section of the pre-deployment checklist, which is designed to be ~ 1 page on the initial prompt.
Post-Deployment
“I want to take updates to the Organization - Before Save - Update flow and the Funding Award After Save flows and deploy them to production. Can you write a post-deployment checklist for me? I want to make sure that all of my users are prepared for the new changes that were made to these flows.”
Note that this prompt has a clear ask and gives parameters of things that the post-deployment checklist should highlight. Describing your intention and priorities in this way is best practice for getting higher quality output.
Potential Follow Ups
Flow Activation: Make sure you’ve done everything needed to have the process working as intended
Example: Is there anything else I should do when validating the flows are active to ensure this process is working correctly?
Hypercare
Monitoring, Case Management, Troubleshooting, Defect Management, Reporting
Metadata Component Documentation
Every metadata component has 1 - 3 sentences of documentation outlining both a business and technical description of the metadata in the Swantide data dictionary. This is designed to give you a view at a glance of what the component is doing.
If you want more information, you can ask the AI Assistant to elaborate. You can also ask more targeted questions, such as how a flow interacts with a certain field
Sample Prompts
Tell me how the Renewals Flow interacts with Opportunity.StageName? Is the flow responsible for setting a StageName value, or is it simply referenced in the flow?
Note that this prompt did not specify which renewals flow we are referring to, and there are multiple renewals flows in this org. You can refine your prompt further to specify the API name of a specific flow if you want a more focused answer
Process Documentation
Many of our customers also want to use Swantide to understand more complex business processes (e.g. tell me everything that happens when a case is created, or tell me how renewals are managed in this org).
Remember that the Swantide AI Assistant can retain ~10 metadata components as context in a single thread. Based on the size and complexity of your org, there may be significantly more metadata components required to answer these types of questions.
The best way to approach these types of questions is to leverage the data dictionary and ask more targeted questions to the AI Assistant. If you are trying to determine what happens when a case is created, you can find the Case object in the Swantide data dictionary, view the referenced metadata components (e.g. Flows, Apex, etc.) and ask the AI Assistant specific questions about what each component does and how it is triggered.
Similarly, if you want to analyze the current renewal process in Salesforce, you could start by asking Swantide how renewals are handled. This will give you a 1-page answer. An alternative approach is to start by asking Swantide how renewal opportunities are distinguished from new business opportunities. Using a Swantide internal org as an example, this is set as Opportunity.Type. You can then find that field in the data dictionary, view references, and ask Swantide follow up questions to build your understanding of how renewals are tracked in this org
See this video for details.
Debugging & Troubleshooting
Swantide is a great way to debug unexpected behavior in the org. Common use cases include:
Copying/pasting an error generated by a validation rule and asking Swantide 1) what rule is responsible, and 2) how can I bypass?
Describing unexpected behavior and asking what automation is responsible (e.g. my users are receiving email with Subject Line X and I would like to turn them off, what automation is responsible for sending these emails?)
Describing behavior that did not occur (e.g. an email was not sent out), and Swantide identifies the flow responsible for sending the email)
Copying/pasting a flow debug error and asking Swantide to analyze the root cause and remediation steps
Best Practices & Considerations
Swantide does not access record-level data nor accept screenshots. So, if you’re seeing unexpected behavior on a record (e.g. trying to understand why LeadSource changed unexpectedly), Swantide can help analyze and identify the metadata touching the LeadSource field and provide suggestions for remediation. It will not accept a recordID or URL and explain what happened on that specific record.
See this video for an example of debugging using Swantide.
FAQs
What happens when I install Swantide?
Swantide is a managed package with a connected app. After the package is installed and authorized in an org, Swantide pulls down metadata via the Metadata & Tooling API. We also use these APIs for metadata deployments via AI Admin and Workflows.
How do I get an org documented? What is actually happening when you document an org?
Swantide uses the Salesforce Metadata API and Tooling API to ingest and generate documentation for every metadata component in Salesforce.
If you need an org to be connected to Swantide, reach out to our team. We will create a Swantide instance, which will include an onboarding form with a link to install the Swantide package and authorize the connection.
How many users can I add to Swantide?
Swantide is priced on a per-org basis. This means that you can add as many users as you want to have access to Swantide. If you want to add users, send their email address to Swantide and we will create them as users. We are working to add user permissioning in app for customers to manager
What are the prerequisites for using AI Assistant & AI Admin?
The Salesforce org needs to be documented by Swantide. Note that the process of documenting all of the metadata in an org takes 24 - 48 hours, so there is some lead time required for this.
How do I add users / manage permissions? How can I access different orgs?
If you have multiple orgs connected to Swantide, you can change the org that you’re in by going to Profile. This will show all of your available orgs.
Today, user and org management is handled by the Swantide team. If you need to add new users, deactivate users, or add new orgs, send the updates to Swantide. Soon we will have user management in app to be managed by customers.
Can Swantide support things like CPQ that have managed package components and/or use record-level data as part of business logic?
Yes! Swantide can see all of the metadata that is not hidden by a managed package and not record-level data. We can see metadata that has been built to reference package components as well. We have several customers who use Swantide in orgs with CPQ to understand the custom logic, write test cases, write enablement documentation, etc.
On our product roadmap is the ability to opt into having certain record-level data documented and in scope for Swantide.
What visibility do different users have?
Documentation in the data dictionary is shared across all users in the org
AI Admin tasks are visible to all users in the org, but can only be deployed by the user who created them
AI Assistant chats are stored at the user level
What AI models does Swantide use?
Swantide leverages enterprise grade models from OpenAI, Anthropic, and Gemini. The Swantide product is built in a way that allows us to swap out models as needed.
Are there any technical limits to the Swantide AI Admin and AI Assistant?
Two important rules of thumb when prompting the AI Assistant:
The AI Assistant can handle 10 - 15 metadata components per thread. When you ask a question, Swantide searches for the most relevant metadata to retain as context to answer the question. This helps reduce time to response and prevent diluted answers.
If you need to answer a question that references more than 10 - 15 metadata components, use the References table in the data dictionary. This table is an exhaustive list of metadata references, and you can filter from there
For each prompt to the Swantide AI Assistant, expect about a 1 page answer
The Swantide AI Admin can handle 40+ metadata components as part of a single task. If you need to update that many components as part of a change you’re making, it may be easier to break down the task into smaller chunks, depending on the complexity and number of revisions the task requires.
Neither products touch anything that is record-level data; the scope is exclusively metadata.
Swantide does not support file uploads - everything must be included in the body of the prompt.
How can I filter in the data dictionary?
You can filter by metadata type (e.g. CustomObject, CustomField, Flow, Validation Rule). We leverage AI to compile this list of references by searching through the metadata JSON of every component in the org.
If you want to filter to Flows that reference a specific object or field, find that field in the data dictionary, navigate to references, go to ‘Components that reference this component’, and filter to Flows.
An important consideration is that these tables show all references
If you need a more granular list (e.g. all flows that run when an opportunity is created), today we suggest finding the list of all references in the Data Dictionary and asking more targeted questions
What do I do if there is a component that isn’t documented?
Swantide can see what you see in the org - Salesforce managed packages that include Apex Code are not visible in Salesforce or to Swantide. Other managed package components (e.g. objects, fields, validation rules, etc.) that are not hidden are visible to Swantide. The apex classes will appear in the data dictionary, but there will be no documentation generated.
What Salesforce products does Swantide support?
Generally, everything on the core Salesforce platform is accessible through Swantide and uses the metadata API. Products that are not on the core Salesforce platform (legacy Pardot, Tableau, etc.) are out of scope for Swantide.
Can I export the documentation?
Since documentation is updated nightly, exporting can lead to having inaccurate documentation. Best practice is to refer to documentation in the Swantide App. A copy/paste function can also be used in AI Assistant for specific pieces of documentation. This is also useful
Does Swantide have access to old versions of metadata components?
Swantide does maintain a change log, accessible through the data dictionary, that shows the date and time of the last change.
The AI Assistant has access to the current version of documentation and the version immediately prior. We don’t store older documentation to assist with performance.
You can ask Swantide what changed in the prior version, and it will summarize for you
How often is the documentation updated? How does that work?
After initial documentation (24-72 hours), orgs will be updated every night to reflect any new changes
How does Swantide retain context in an AI Assistant thread?
Swantide is able to retain context in an existing thread. This means that you shouldn’t need to continue referencing the names of the same metadata components when asking follow up questions.
Because we retain the context, you should always start a new thread if you’re asking a different question. This helps prevent retaining irrelevant context that could dilute your answer.
What happens if I want to manually sync an update before the nightly sync?
Using the Data Dictionary, select the metadata component you would like to update. Once selected, click on the “Sync Component” button on the top right of your screen.
This works for syncing existing metadata components. We are releasing a feature very soon to be able to sync new metadata components instantly.
How do I get support?
Reach out to the Swantide team on Slack channel or email (support@swantide.com)
What are common mistakes people make?
Asking AI Assistant too broad of questions or asking too much in a single prompt.
Ex: Can you show all of the active flows in my org?
Ex: Can you compare and contract all of the profiles in my org?
Not asking follow up questions to AI Assistant to continue to refine and get better answers
Tasking AI Admin with too much metadata (break up into smaller tasks)