---
title: "Guides"
description: "Every guide in Credal | Documentation."
---

# Guides

Every guide in Credal | Documentation.

- [API Reference](./guides/api-reference-2-index.md)
- [API Reference](./guides/api-reference-index.md)
- [Getting Started](./guides/getting-started-index.md)
- [Platform](./guides/platform-index.md)
- [Agent Builder](./guides/platform-agent-builder.md)
  - [Configuration](./guides/platform-configuration.md)
    - [Setting Up An Agent](./guides/platform-agent-builder-configuration-setting-up-an-agent.md)
    - [AI Model](./guides/platform-agent-builder-configuration-choosing-a-model.md)
    - [Writing a Background Prompt](./guides/platform-agent-builder-configuration-writing-instructions.md)
    - [Add Connectors](./guides/platform-add-connectors.md)
      - [Connectors](./guides/platform-agent-builder-configuration-add-connectors-overview.md)
      - [Data Sources](./guides/platform-agent-builder-configuration-add-connectors-data.md)
      - [Actions](./guides/platform-agent-builder-configuration-add-connectors-actions.md)
      - [Document Collections](./guides/platform-document-collections.md)
        - [Document Collections](./guides/platform-agent-builder-configuration-add-connectors-document-collections-overview.md)
        - [Smart Filtering (beta)](./guides/platform-agent-builder-configuration-add-connectors-document-collections-smart-filtering-beta.md)
        - [Collection Schemas](./guides/platform-agent-builder-configuration-add-connectors-document-collections-collection-schemas.md)
        - [AI Entity Extraction (beta)](./guides/platform-agent-builder-configuration-add-connectors-document-collections-ai-entity-extraction-beta.md)
        - [Bring Your Own Custom Data Sources](./guides/platform-agent-builder-configuration-add-connectors-document-collections-bring-your-own-custom-data-sources.md)
      - [Credal MCP Servers](./guides/platform-agent-builder-configuration-add-connectors-credal-mcp-servers.md)
    - [Agent Collaboration](./guides/platform-agent-builder-configuration-agent-collaboration.md)
    - [Memory and Feedback](./guides/platform-agent-builder-configuration-memory-and-feedback.md)
  - [Testing Your Agent](./guides/platform-agent-builder-testing-your-agent.md)
  - [Evaluating Your Agent](./guides/platform-evaluating-your-agent.md)
    - [Overview](./guides/platform-agent-builder-evaluating-your-agent-overview.md)
    - [Agent Benchmark](./guides/platform-agent-builder-evaluating-your-agent-agent-benchmark.md)
    - [Agent Reliability Score](./guides/platform-agent-builder-evaluating-your-agent-agent-reliability-score.md)
  - [Publishing Agents](./guides/platform-publishing-agents.md)
    - [Use your Agents where you work](./guides/platform-agent-builder-publishing-agents-overview.md)
    - [Agent Versions](./guides/platform-agent-builder-publishing-agents-versions-forking.md)
    - [Making Agents available in Slack](./guides/platform-agent-builder-publishing-agents-agents-in-slack.md)
    - [Custom Dedicated Slack Bots](./guides/platform-agent-builder-publishing-agents-custom-dedicated-slack-bots.md)
    - [Connecting an Agent to a Slack Workflow](./guides/platform-agent-builder-publishing-agents-slack-workflow-automation.md)
    - [Microsoft Teams Setup](./guides/platform-microsoft-teams.md)
    - [API Deployment](./guides/platform-agent-builder-publishing-agents-api-deployment.md)
    - [Agents and MCP Servers](./guides/platform-agent-builder-publishing-agents-agents-and-mcp-servers.md)
- [Copilots](./guides/api-reference-2-copilots.md)
  - [Create Copilot](./guides/api-reference-2-api-reference-copilots-create-copilot.md)
  - [Create Conversation](./guides/api-reference-2-api-reference-copilots-create-conversation.md)
  - [Provide Message Feedback](./guides/api-reference-2-api-reference-copilots-provide-message-feedback.md)
  - [Add Collection To Copilot](./guides/api-reference-2-api-reference-copilots-add-collection-to-copilot.md)
  - [Remove Collection From Copilot](./guides/api-reference-2-api-reference-copilots-remove-collection-from-copilot.md)
  - [Update Configuration](./guides/api-reference-2-api-reference-copilots-update-configuration.md)
  - [Delete Copilot](./guides/api-reference-2-api-reference-copilots-delete-copilot.md)
  - [Export](./guides/api-reference-2-api-reference-copilots-export.md)
  - [Send Message](./guides/api-reference-2-api-reference-copilots-send-message.md)
  - [Stream Message](./guides/api-reference-2-api-reference-copilots-stream-message.md)
- [Overview](./guides/api-reference-overview.md)
- [What is Credal?](./guides/getting-started-introduction.md)
- [Fetch the status of an agent response](./guides/api-reference-v-1-agents-fetch-response.md)
- [Quickstart](./guides/getting-started-quickstart.md)
- [Agent Building Tutorial](./guides/getting-started-video-agent-building-basics.md)
- [Send a message to an agent](./guides/api-reference-v-1-agents-send-message.md)
- [OAuth Setup](./guides/api-reference-v-1-o-auth-setup.md)
- [Tutorials: Common First Agents](./guides/getting-started-tutorials-common-first-agents.md)
  - [Employee Onboarding Assistant](./guides/getting-started-employee-onboarding-assistant.md)
    - [Overview](./guides/getting-started-tutorials-common-first-agents-employee-onboarding-assistant-overview.md)
    - [Answer Basic Questions](./guides/getting-started-tutorials-common-first-agents-employee-onboarding-assistant-answer-basic-questions.md)
    - [Searching Internal and External Knowledge](./guides/getting-started-tutorials-common-first-agents-employee-onboarding-assistant-searching-internal-and-external-knowledge.md)
    - [Connect with Internal Systems](./guides/getting-started-tutorials-common-first-agents-employee-onboarding-assistant-connect-with-internal-systems.md)
  - [IT Security Assistant](./guides/getting-started-it-security-assistant.md)
    - [IT Security Agent](./guides/getting-started-tutorials-common-first-agents-it-security-assistant-overview.md)
    - [Answer User Questions](./guides/getting-started-tutorials-common-first-agents-it-security-assistant-answer-questions-with-data.md)
    - [Tracking Requests in Jira](./guides/getting-started-tutorials-common-first-agents-it-security-assistant-track-tickets-in-jira.md)
    - [Publishing to Slack](./guides/getting-started-tutorials-common-first-agents-it-security-assistant-publish-to-slack.md)
  - [Snowflake Query Assistant](./guides/getting-started-snowflake-query-assistant.md)
    - [Creating a Snowflake Query Assistant](./guides/getting-started-tutorials-common-first-agents-snowflake-query-assistant-overview.md)
    - [Initial Snowflake Setup](./guides/getting-started-tutorials-common-first-agents-snowflake-query-assistant-initial-snowflake-setup.md)
    - [Query Approaches](./guides/getting-started-tutorials-common-first-agents-snowflake-query-assistant-query-approaches.md)
    - [Testing your solution](./guides/getting-started-tutorials-common-first-agents-snowflake-query-assistant-testing-your-solution.md)
  - [Salesforce Query Assistant](./guides/getting-started-salesforce-query-assistant.md)
    - [Building a Salesforce Agent](./guides/getting-started-tutorials-common-first-agents-salesforce-query-assistant-overview.md)
- [Overview](./guides/api-reference-v-1-overview.md)
- [Document Catalog](./guides/api-reference-2-document-catalog.md)
  - [Upload Document Contents](./guides/api-reference-2-api-reference-document-catalog-upload-document-contents.md)
  - [Upload File](./guides/api-reference-2-api-reference-document-catalog-upload-file.md)
  - [Sync Source By Url](./guides/api-reference-2-api-reference-document-catalog-sync-source-by-url.md)
  - [Metadata](./guides/api-reference-2-api-reference-document-catalog-metadata.md)
- [Document Collections](./guides/api-reference-2-document-collections.md)
  - [Search Document Collection](./guides/api-reference-2-api-reference-search-search-document-collection.md)
  - [Add Documents To Collection](./guides/api-reference-2-api-reference-document-collections-add-documents-to-collection.md)
  - [Remove Documents From Collection](./guides/api-reference-2-api-reference-document-collections-remove-documents-from-collection.md)
  - [List Documents In Collection](./guides/api-reference-2-api-reference-document-collections-list-documents-in-collection.md)
  - [Create Collection](./guides/api-reference-2-api-reference-document-collections-create-collection.md)
  - [Delete Collection](./guides/api-reference-2-api-reference-document-collections-delete-collection.md)
  - [Create Mongo Collection Sync](./guides/api-reference-2-api-reference-document-collections-create-mongo-collection-sync.md)
  - [Update Mongo Collection Sync](./guides/api-reference-2-api-reference-document-collections-update-mongo-collection-sync.md)
- [FAQs: Common Questions and Answers](./guides/getting-started-faqs.md)
- [Users](./guides/api-reference-2-users.md)
  - [Metadata](./guides/api-reference-2-api-reference-users-metadata.md)
- [Service Accounts](./guides/api-reference-2-v-0-service-accounts.md)
- [Governed Actions](./guides/platform-governed-actions.md)
  - [Overview](./guides/platform-governed-actions-overview.md)
  - [Action Templates](./guides/platform-governed-actions-action-templates.md)
  - [Customizing Actions](./guides/platform-governed-actions-custom-names-and-descriptions.md)
  - [Credal Open Source Actions](./guides/platform-governed-actions-open-source-actions.md)
  - [Credentials and Security](./guides/platform-governed-actions-credentials-and-security.md)
  - [Human Approval Options](./guides/platform-governed-actions-human-approval-options.md)
  - [Action Parameters](./guides/platform-governed-actions-action-parameters.md)
- [MCP Server Builder](./guides/platform-mcp-server-builder.md)
  - [MCP Servers Overview](./guides/platform-mcp-server-builder-overview.md)
  - [Create a new Server](./guides/platform-mcp-server-builder-create-a-new-server.md)
  - [Attaching connectors](./guides/platform-mcp-server-builder-attaching-connectors.md)
  - [Connecting Agents](./guides/platform-mcp-server-builder-connecting-agents.md)
  - [Testing your Server](./guides/platform-mcp-server-builder-testing-your-server.md)
  - [Publishing your Server](./guides/platform-mcp-server-builder-publishing-your-server.md)
  - [Advanced Usage (Beta)](./guides/platform-mcp-server-builder-advanced-usage.md)
- [Managing MCP Servers](./guides/platform-managing-mcp-servers.md)
  - [Third-party Server Registration](./guides/platform-managing-mcp-servers-third-party-server-registration.md)
  - [Setting up Controls](./guides/platform-managing-mcp-servers-setting-up-controls.md)
  - [Publishing your Third-Party Server](./guides/platform-managing-mcp-servers-publishing-the-server.md)
  - [Monitoring Usage](./guides/platform-managing-mcp-servers-monitoring-usage.md)
- [Bulk Analysis (FDE Engagements Only)](./guides/platform-bulk-analysis.md)
- [Administration](./guides/platform-administration.md)
  - [Single Sign-On (SSO)](./guides/platform-administration-single-sign-on-sso.md)
  - [Audit Logs API](./guides/platform-administration-audit-logs-api.md)
  - [Audit Log / Data Exports](./guides/platform-administration-data-warehouse-integration.md)
  - [Connect MCP Clients](./guides/platform-administration-connect-mcp-clients.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.
