Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 40 additions & 24 deletions fern/docs/pages/agent-building.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,32 +29,48 @@ Access our comprehensive agent building training session. This pre-recorded walk
setup and configuration to prompts and data sources.
</p>

<div
style={{
display: "flex",
gap: "16px",
fontSize: "14px"
}}
>
<div style={{ flex: 1 }}>
<strong>You'll Learn:</strong> Agent setup & configuration, as well as the full agent creation cycle
</div>
<div style={{ flex: 1 }}>
<strong>Perfect For:</strong> Anyone looking to build and deploy
an agent with Credal
</div>
<div
style={{
display: "flex",
gap: "16px",
fontSize: "14px",
}}
>
<div style={{ flex: 1 }}>
<strong>You'll Learn:</strong> Agent setup & configuration, as well as the
full agent creation cycle
</div>

<div style={{ marginTop: "16px", borderRadius: "4px", overflow: "hidden", position: "relative", paddingBottom: "56.25%", height: 0 }}>
<iframe
src="https://www.loom.com/embed/8531c5782c1943ecb930a501edcca1f2"
frameBorder="0"
webkitallowfullscreen
mozallowfullscreen
allowFullScreen
style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%" }}
></iframe>
<div style={{ flex: 1 }}>
<strong>Perfect For:</strong> Anyone looking to build and deploy an agent
with Credal
</div>
</div>

<div
style={{
marginTop: "16px",
borderRadius: "4px",
overflow: "hidden",
position: "relative",
paddingBottom: "56.25%",
height: 0,
}}
>
<iframe
src="https://www.loom.com/embed/8531c5782c1943ecb930a501edcca1f2"
frameBorder="0"
webkitallowfullscreen
mozallowfullscreen
allowFullScreen
style={{
position: "absolute",
top: 0,
left: 0,
width: "100%",
height: "100%",
}}
></iframe>
</div>

</div>

Expand Down
6 changes: 5 additions & 1 deletion fern/docs/pages/platform/actions/open-source-actions.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Credal Open Source Actions

<Callout intent="info" icon="fa-brands fa-github" title="Credal Actions SDK is open source">
<Callout
intent="info"
icon="fa-brands fa-github"
title="Credal Actions SDK is open source"
>
Browse existing actions, open issues, or submit a PR on GitHub:
**[github.com/credal-ai/actions-sdk](https://github.com/credal-ai/actions-sdk)**
</Callout>
Expand Down
11 changes: 8 additions & 3 deletions fern/docs/pages/platform/agents/agent-evaluate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,23 @@ When generating test cases, you can choose which document sources inform the que

Once generated, the test cases appear in your Evaluate tab alongside any manually created ones. You can edit the questions and rubrics, or delete any that don't fit your needs.

<div style={{position: "relative", paddingBottom: "53.23%", height: 0}}>
<div style={{ position: "relative", paddingBottom: "53.23%", height: 0 }}>
<iframe
src="https://www.loom.com/embed/05169c6427b646e99c86f5bafdcebafc"
frameborder="0"
webkitallowfullscreen
mozallowfullscreen
allowfullscreen
style={{position: "absolute", top: 0, left: 0, width: "100%", height: "100%"}}
style={{
position: "absolute",
top: 0,
left: 0,
width: "100%",
height: "100%",
}}
></iframe>
</div>


### **Creating Rubrics**

For each test question, you can define a custom rubric that specifies what makes a good answer. Rubrics allow you to:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Great! Now your agent is discoverable by other agents!

4. You can either make the Agent visible to all other Agents (only possible by an admin), or you can add an eligible caller to provide access on a per-Agent level. User level access coming soon. Today, you can restrict user level access to an action by deploying the Agent to a private Slack channel or creating a user group (contact support@credal.ai to set this up).


## 2. **Connecting to an Agent**

Now that you have some discoverable agents, you can connect other agents to it. To do this, let's connect an agent to the one we just made discoverable:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,14 @@ If none have been attached yet it will look like:
If data sources have already been attached you'll see them listed by connector
![attached-data-sources.png](/docs/assets/agents/create-steps/attached-data-sources.png)


**2. Attaching Sources**

You can either select a synced source, sync a URL, or upload your own files.
You can either select a synced source, sync a URL, or upload your own files.

If you want to attach a [document collection](/user-guide/platform/agent-builder/configuration/add-connectors/document-collections), this will be under select a source.

![copilot_data_sources.png](/docs/assets/copilots/copilot_data_sources.png)


**2. Bookmarking Data**

By bookmarking (or pinning) data sources, you can force your agent to refer to certain sources for _every_ user query, as opposed to just prioritizing the attached data. You should use this for documents that will relate to most queries you expect your agent to address. If you have a document that you always want your agent to refer to, put it here. This could include answers to FAQs or a sales playbook. As pinned sources will be read in their entirety every time a user asks a question, they should only be used for a limited amount of high quality data to avoid overwhelming the AI with too much data on every question.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,28 +26,28 @@ You'll be taken to your new collection's configuration page automatically.
After creation, your collection has four tabs:

1. Configure
This is where you set up your collection's content and settings:
Metadata
— Edit the name and description of your collection at any time.
Smart Filtering Schema
— Define custom metadata fields for your documents (e.g., department, document type, date). This enables more precise filtering when your agent searches the collection.
Data
— Add content to your collection (see below).
Performance
— If available, enable dedicated search capacity for faster results on large collections.
This is where you set up your collection's content and settings:
Metadata
— Edit the name and description of your collection at any time.
Smart Filtering Schema
— Define custom metadata fields for your documents (e.g., department, document type, date). This enables more precise filtering when your agent searches the collection.
Data
— Add content to your collection (see below).
Performance
— If available, enable dedicated search capacity for faster results on large collections.

2. API
View your collection's unique ID and manage API keys for programmatic access. This tab also links to API documentation if your developers need to integrate with the collection.
<Frame>
<img src="/docs/assets/collections/collections-api-tab.png" />
</Frame>
View your collection's unique ID and manage API keys for programmatic access. This tab also links to API documentation if your developers need to integrate with the collection.

<Frame>
<img src="/docs/assets/collections/collections-api-tab.png" />
</Frame>

3. Preview Semantic Search
Test your collection by running sample searches. This helps you verify that the right documents are being found before connecting the collection to an agent.
Test your collection by running sample searches. This helps you verify that the right documents are being found before connecting the collection to an agent.

4. Monitor
View a log of searches that have been run against your collection.

View a log of searches that have been run against your collection.

#### Adding Content to Your Collection

Expand All @@ -56,11 +56,12 @@ From the Configure tab, scroll to the Data section. You have three main ways to
**Upload new files** — Upload documents directly from your computer.
**Public Webpages** — Click the Public Webpages button to add content from publicly accessible web URLs.

<Frame>
<img src="/docs/assets/collections/collections-data.png" />
</Frame>
<Frame>
<img src="/docs/assets/collections/collections-data.png" />
</Frame>

#### Sharing Your Collection

Click the Share button at the top of your collection's page to manage who has access:
Add collaborators by searching for teammates within your organization.
Remove collaborators by clicking the remove icon next to their name.
Expand All @@ -69,14 +70,17 @@ Organization admins automatically have access to all collections.
> Note: Every collection must have at least one collaborator. You cannot remove the last remaining collaborator.

#### Connecting a Collection to an Agent

To use your collection as a knowledge source for an AI agent:

- Open the agent you want to configure in the Agent Builder.
- Go to the Data Sources section (or Connectors, depending on your interface).
- Select your document collection as a data source.

The agent will now be able to search your collection's content when answering user questions, respecting each user's document-level permissions.

#### Deleting a Collection

- Open the collection you want to delete.
- Click the trash icon button at the top of the page.
- Confirm the deletion in the dialog.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,23 @@ Connectors allow you to integrate the systems you use in your day-to-day work wi
## What You Can Connect

- **[Indexed Data](/user-guide/platform/agent-builder/configuration/add-connectors/data)** – Sync and search your data sources

- Best for fast semantic responses
- Data is synced nightly

- **[Actions](/user-guide/platform/agent-builder/configuration/add-connectors/actions)** – Dynamically interact with your connected systems

- Best for live data extraction and writing to your systems in real time
- Supports human-in-the-loop workflows
- May have slightly higher latency

- **[MCP Servers](/user-guide/platform/mcp-servers/overview)** – Integrate Model Context Protocol servers

- Connect third-party MCP servers instantly
- **[Build your own custom MCP servers](/user-guide/platform/mcp-servers/mcp-server-builder/create-new-server)** directly in Credal on top of your data—define custom parameters, descriptions, and logic to tailor exactly how agents interact with your systems

- **[Document Collections](/user-guide/platform/agent-builder/configuration/add-connectors/document-collections)** – Curated sets of data for specific use cases

- Curate data for a particular function
- Use AI entity extraction to enable granular filtering by date ranges, account names, concepts, and more

Expand Down
24 changes: 12 additions & 12 deletions fern/docs/pages/platform/agents/configure-steps/connectors/saas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,33 @@ title: Actions
In this section, you can attach one or more **published actions** to the agent. Actions allow agents to dynamically connect to external systems or trigger workflows based on user input.

- Click on **Add Connector** to view all the action providers available to you
![no-attached-actions.png](/docs/assets/actions/no-attached-actions.png)
![no-attached-actions.png](/docs/assets/actions/no-attached-actions.png)

- Use the dropdown to search for an action used within a particular tool/integration
![action-provider-selection.png](/docs/assets/actions/action-provider-selection.png)
![action-provider-selection.png](/docs/assets/actions/action-provider-selection.png)

- Select one or more **read** or **write** published actions
- Read actions will query data and retrieve it for the agent to consume
- Write actions will take real world action and accomplish tasks within tools
- Once all the actions are selected click the "Add" button in the bottom right

- Read actions will query data and retrieve it for the agent to consume
- Write actions will take real world action and accomplish tasks within tools
- Once all the actions are selected click the "Add" button in the bottom right
![action-selection.png](/docs/assets/actions/action-selection.png)

- You'll see it show up in the connectors section of the agent configuration
![attached-actions.png](/docs/assets/actions/attached-actions.png)
![attached-actions.png](/docs/assets/actions/attached-actions.png)

- This is where you can further configure them
- Click on the pencil icon to edit and personalize them

- Click on the pencil icon to edit and personalize them
![action-details.png](/docs/assets/actions/action-details.png)

- When editing the action you can scroll down to modify the parameters of the action
![action-parameters.png](/docs/assets/actions/action-parameters.png)
![action-parameters.png](/docs/assets/actions/action-parameters.png)

- If you scroll even further you'll be able to see the optional human in the loop settings. This setting makes sure that the agent asks for permission every time it needs to take this action. It will wait for the user to approve usage of the action before proceeding.
![action-governance.png](/docs/assets/actions/action-governance.png)
![action-governance.png](/docs/assets/actions/action-governance.png)

- Once added you'll notice the small orange hammer icon on the action
![action-with-gov-icon.png](/docs/assets/actions/action-with-gov-icon.png)

![action-with-gov-icon.png](/docs/assets/actions/action-with-gov-icon.png)

Attaching the right actions ensures that your agent can not only respond to questions but also execute real-world tasks across integrated systems.

1 change: 0 additions & 1 deletion fern/docs/pages/platform/agents/configure-steps/prompt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ information at a specific point, or look at specific data before making a decisi

Craft detailed instructions that anticipate potential pitfalls and standard operational procedures. Your Agent will only know as much as you tell it. Noticing that the responses are too long? Specify response length! Think there's too much fluff in the language? Ask for concise language.


## Provided Prompt Snippets

Credal has prompt snippets right under the background prompt in the Agent Configuration tab. This is a great way to drop phrases into the background prompt that can help improve agents. This can take the form
Expand Down
5 changes: 4 additions & 1 deletion fern/docs/pages/platform/mcp-servers/publishing-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ Here is an example of how you can directly publish to all users in ChatGPT

### For Other MCP Clients

For all other surfaces, such as Cursor, Windsurf, or any custom MCP client, each server must be connected individually by copying the server's direct URL and adding it to the client manually.
For all other surfaces, such as Lovable, Cursor, Windsurf, or any custom MCP client, each user must connect the URL individually:

- **Lovable**: `https://app.credal.ai/api/user/lovable/mcp`
- **Other clients**: Use the server's direct URL from the Publish tab

## Access Control

Expand Down
4 changes: 2 additions & 2 deletions fern/docs/pages/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ _--------- End Context ---------_
</AccordionGroup>

5. **Data**
The data you provide will be the source of truth for your agent. Your agent will rely on this data (along with the prompt and Q&A pairs) to answer user queries. You should provide your agent with sufficient data relevant to its area of expertise. The data you attach is the most important source of knowledge for the agent.
The data you provide will be the source of truth for your agent. Your agent will rely on this data (along with the prompt and Q&A pairs) to answer user queries. You should provide your agent with sufficient data relevant to its area of expertise. The data you attach is the most important source of knowledge for the agent.

There are two ways you can provide data to the agent:

Expand All @@ -114,7 +114,7 @@ _--------- End Context ---------_
Alternatively, you may want to allow the user to attach one or more source documents at the time of their question. For example, you may create an agent for generating meeting notes based on a transcript, and you want to allow your user to provide a different transcript each time they use the agent. This can be accomplished by creating a user input.

**Advanced Settings**
There are some advanced settings you can use to control how your agent searches through the attached data. For most use cases, you should leave the default settings.
There are some advanced settings you can use to control how your agent searches through the attached data. For most use cases, you should leave the default settings.

For advanced use cases, you can specify how many of the most relevant chunks (a chunk is roughly 2-3 sentences) the agent should read. You can also set a relevancy score cutoff.

Expand Down
12 changes: 10 additions & 2 deletions fern/docs/pages/tutorials/slack-workflows/slack-workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ Credal now supports triggering agents via Slack Workflows — on a schedule or b
src="https://www.loom.com/embed/4515a790e2c84bab995a335b821cfd41"
frameBorder="0"
allowFullScreen
style={{ position: "absolute", top: 0, left: 0, width: "100%", height: "100%" }}
style={{
position: "absolute",
top: 0,
left: 0,
width: "100%",
height: "100%",
}}
></iframe>
</div>

Expand All @@ -22,7 +28,9 @@ Before setting up a Slack Workflow trigger, your agent must already be published
In your agent's **Publish** settings, go to **Slack Channels**, enable **Talk to your agent in Slack**, and add the agent to the channel where your Slack Workflow will post.

<Callout intent="info">
Make sure the body text of your Slack Workflow message is structured to trigger the agent correctly based on your agent's routing settings (e.g. matching a filter, or triggering on all messages).
Make sure the body text of your Slack Workflow message is structured to
trigger the agent correctly based on your agent's routing settings (e.g.
matching a filter, or triggering on all messages).
</Callout>

### Step 2: Copy your Workflow ID from Slack
Expand Down
2 changes: 1 addition & 1 deletion fern/docs/user-guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ navigation:
- page: Monitoring Usage
path: ./pages/platform/mcp-servers/monitoring-usage.mdx
- page: Bulk Analysis
# Soon to be turned into workflows, but the credal way :)
# Soon to be turned into workflows, but the credal way :)
path: ./pages/platform/bulk-analysis.mdx
- section: Integrations
# Soon to be renamed Document Collections
Expand Down
Loading