-
Notifications
You must be signed in to change notification settings - Fork 3
A bunch more improvements to the documentation :) #344
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -20,47 +20,73 @@ | |||||
| </Card> | ||||||
| </CardGroup> | ||||||
|
|
||||||
| ## What is Credal? | ||||||
| # What is Credal? | ||||||
|
|
||||||
| Credal is a platform that empowers enterprises to build secure, intelligent AI agents tailored to any workflow, with native support for enterprise data and access controls. | ||||||
| Credal gives enterprises a library of hosted agents and tools with built-in controls, accessible wherever your employees want to chat with AI. It's the centralized trust layer for governing and scaling AI agents, MCP servers, toolkits, and skills—connected to any system, operating within the security and permission boundaries your organization requires. | ||||||
|
|
||||||
| ## What is an Agent? | ||||||
| ## What Can You Build? | ||||||
|
|
||||||
| An agent is more than just a chatbot. It's a system capable of reasoning and taking actions to achieve goals. It combines two core capabilities: | ||||||
| Credal supports the full stack of agentic infrastructure: | ||||||
|
|
||||||
| 1. **Reasoning** – Analyzing information, context, or instructions to determine the next steps. | ||||||
| 2. **Action-taking** – Performing tasks such as calling APIs, generating outputs, or interacting with external systems based on its reasoning. | ||||||
| - **Agents** – Systems that reason and take action to complete goals across your enterprise data and systems. | ||||||
| - **MCP Servers** – Expose governed, reusable tools and data connections that any agent or AI application can call, via the Model Context Protocol. | ||||||
| - **Toolkits** – Curated collections of tools that can be shared, versioned, and activated across your organization. | ||||||
| - **Skills** – Reusable capabilities that agents can invoke—queryable knowledge, API calls, workflows—built once and available everywhere. | ||||||
|
|
||||||
| Unlike simple chatbots that just respond, agents **reason and act**. For example: | ||||||
|
|
||||||
| - A chatbot might answer: “It’s 75°F and sunny in New York.” | ||||||
| - An agent could fulfill: "Book me a flight to New York for tomorrow," by searching for flights, choosing the best option, and completing the booking. | ||||||
| Everything you build in Credal is governed from day one: permissioned, auditable, and deployable at enterprise scale. | ||||||
|
|
||||||
| ## Why Credal? | ||||||
|
|
||||||
| ### 1. **Enterprise Data Integrations** | ||||||
| ### A Governed Library of Agents and Tools | ||||||
|
|
||||||
| Credal provides a central library of tools and company data collections that your AI platform team can customize, document, and govern. Tools can be enriched with curated context, scoped to the right audiences, and extended dynamically—Credal can write code to perform complex multi-step workflows and repackage them as first-class tools in your library. Builders and users can browse, activate, and stack vetted tools without starting from scratch. | ||||||
|
|
||||||
| ### Agents That Work Where Your Teams Work | ||||||
|
|
||||||
| Credal publishes agents to every surface your teams already use—Slack, the web, APIs, chat interfaces, and more. Users get access to agentic tooling where they work, not in a separate tool. And as those surfaces multiply, you need a single place where tooling is created, maintained, and governed—otherwise you're managing sprawl. | ||||||
|
|
||||||
| ### An Agent Builder with Built-In Evaluation | ||||||
|
|
||||||
| Build agents through a UI, in natural language, or via API. Credal's agent builder includes native evaluation capability so you can test, iterate, and validate before deploying to your organization—closing the gap between prototype and production. | ||||||
|
|
||||||
| ### Model-Agnostic by Design | ||||||
|
|
||||||
| Credal works across model providers. Most enterprises already use multiple LLMs because different models excel at different tasks. Credal lets you build agentic systems that use the right model for the right job, without rebuilding for each provider. | ||||||
|
|
||||||
| ### Market-Leading Enterprise Context | ||||||
|
|
||||||
| Connect to all major [enterprise data sources](/user-guide/platform/integrations/data-sources-action-providers)—Slack, Confluence, Google Drive, Salesforce, databases, and more—for unified search, knowledge retrieval, and advanced analytics. With enterprise-grade security, every API connection and query follows your organization's access controls, ensuring your agents can safely surface insights and documents across your company's knowledge base. Whether answering questions, driving business processes, or enabling complex workflows, your data remains fully protected. | ||||||
| Index and curate unstructured data—Slack, Confluence, Google Drive, Salesforce, databases, and more—and make it available to any agent or AI application from a single place. Structured and semi-structured data sources can be centrally configured and fetched securely. Your agents get better context; your admins get full visibility into what's being accessed. | ||||||
|
|
||||||
| ### 2. **Agentic Capabilities** | ||||||
| ### Administrative Visibility and Control | ||||||
|
|
||||||
| Build intelligent agents that collaborate to execute multi-step workflows across your enterprise data. Agents automatically share capabilities—when one agent learns to query Salesforce, every agent in your organization can leverage that skill. Design sophisticated, secure workflows where [specialized agents coordinate](/user-guide/platform/agent-builder/configuration/agent-collaboration) on complex tasks, accelerating decision-making while maintaining strict data governance. | ||||||
| Credal isn't just secure—it's where you can safely deploy agents that take real actions: sending emails, processing payments, modifying records. | ||||||
|
|
||||||
| ### 3. **Publish Anywhere** | ||||||
| **For admins:** | ||||||
| - A single control panel for all agents and tools across the organization | ||||||
| - See every agent using a given system (e.g., "What are all the agents using Google Drive for?") | ||||||
| - Identify documents with incorrect underlying permissions before AI surfaces them further | ||||||
| - Set global rules: require approval for external emails, cap payment amounts, block destructive operations | ||||||
| - Enforce permission boundaries across every agent in the enterprise (authentication, authorization, auditability) | ||||||
| - Measure and drive adoption across the user base from a single dashboard | ||||||
|
|
||||||
| Publish your agents wherever your teams work. Use them on the web, in Slack, through APIs, with other agents, or in any chat interface (with more integrations coming soon). Every published agent inherits Credal's enterprise-grade security, ensuring your knowledge remains private while your teams stay productive. | ||||||
| **For builders:** | ||||||
| - Browse and activate vetted connectors, skills, and agents from a central hub | ||||||
| - Evaluate solutions and scale them to teams and the organization quickly | ||||||
| - Stack governed, pre-vetted tools to accelerate time-to-production | ||||||
| - Benefit from better search and response accuracy from curated, well-scoped tooling | ||||||
|
|
||||||
| ## Security | ||||||
|
|
||||||
| Credal is built for enterprises—designed to meet the security, compliance, and governance standards required by large organizations. | ||||||
| Credal is built for enterprises—designed to meet the security, compliance, and governance standards large organizations require. | ||||||
|
|
||||||
| - SOC 2 Type II certified, HIPAA-ready, and compliant with the EU/UK/Swiss Data Privacy Framework | ||||||
| - Credal mirrors your existing permissions (Slack, Google, Salesforce, etc.), so agents only access what users are already authorized to see | ||||||
| - Supports human-in-the-loop approval flows and detailed [audit logs](/user-guide/platform/administration/audit-log-data-exports) | ||||||
| - Flexible deployment: Cloud or on-prem, with [SSO and SCIM](/user-guide/platform/administration/single-sign-on-sso) integration for identity and access management | ||||||
| - Mirrors your existing permissions (Slack, Google, Salesforce, etc.)—agents only access what users are already authorized to see | ||||||
| - Supports human-in-the-loop approval flows and detailed audit logs | ||||||
| - Flexible deployment: cloud or on-prem, with SSO and SCIM integration for identity and access management | ||||||
| - Global policy controls for how agents interact with external systems, enforced across every agent in your organization | ||||||
|
|
||||||
| With Credal, enterprises can confidently deploy AI agents that accelerate knowledge workflows without ever compromising security or compliance. | ||||||
| With Credal, enterprises can confidently move from AI experimentation to production—without compromising security, compliance, or control. | ||||||
|
|
||||||
| ## Support | ||||||
|
|
||||||
| For questions or support? Reach out to our team at **[support@credal.ai](mailto:support@credal.ai)**. | ||||||
| Questions or need help? Reach out at **support@credal.ai**. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Broken email link (mailto removed) The
Suggested change
Prompt To Fix With AIThis is a comment left during a code review.
Path: fern/docs/pages/introduction.mdx
Line: 91
Comment:
**Broken email link (mailto removed)**
The `support@credal.ai` address was changed from a clickable `mailto:` hyperlink to plain bold text, making it impossible for users to click and open their email client. Every other support email in the codebase (including `quickstart.mdx`) uses the linked form.
```suggestion
Questions or need help? Reach out at **[support@credal.ai](mailto:support@credal.ai)**.
```
How can I resolve this? If you propose a fix, please make it concise. |
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,36 @@ | ||||||
| # Customizing Actions | ||||||
|
|
||||||
| Credal allows you to assign custom names and descriptions to actions, making them more intuitive and aligned with your organization's business logic and terminology. | ||||||
|
|
||||||
| ## Why Customize Action Names and Descriptions? | ||||||
|
|
||||||
| Third-party integrations and MCP servers often expose actions with technical names that may not reflect how your team thinks about these operations. Custom names and descriptions help: | ||||||
|
|
||||||
| - **Align with Business Terminology**: Use names that match your organization's vocabulary and processes | ||||||
| - **Improve Discoverability**: Make actions easier to find and understand for team members | ||||||
| - **Enhance Agent Performance**: Clear, business-focused descriptions help AI agents select the right actions more accurately | ||||||
| - **Simplify Onboarding**: New team members can understand what actions do without learning technical jargon | ||||||
|
|
||||||
| ## How to Customize | ||||||
|
|
||||||
| When configuring an action, you can override the default name and description: | ||||||
|
|
||||||
| 1. Navigate to the action you want to customize in the Actions section | ||||||
| 2. Click on the action to open its settings | ||||||
| 3. Edit the **Name** field to provide a custom, business-friendly name | ||||||
| 4. Update the **Description** field to explain what the action does in terms relevant to your organization | ||||||
|
|
||||||
|  | ||||||
|
|
||||||
| ## Best Practices | ||||||
|
|
||||||
| - **Be Descriptive**: Use clear, concise names that immediately convey the action's purpose | ||||||
| - **Include Context**: Add business context in descriptions (e.g., "Creates a Jira ticket in our Support queue" instead of "Create Jira issue") | ||||||
| - **Stay Consistent**: Use consistent naming conventions across similar actions | ||||||
| - **Think About Discovery**: Consider how users will search for this action when naming it | ||||||
|
|
||||||
| <Note> | ||||||
| Custom names and descriptions only affect how actions appear within Credal. The underlying integration or MCP server functionality remains unchanged. | ||||||
| </Note> | ||||||
|
|
||||||
| You can distribute and scale usage of your customized actions in any surface through our [custom MCP servers](https://docs.credal.ai/user-guide/platform/mcp-servers/overview). Your HR, Finance, Product, etc. team can then manage their own blessed set of tools for the entire organization to use. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Absolute URL for internal link This is the only internal link in the entire docs codebase that uses an absolute
Suggested change
Prompt To Fix With AIThis is a comment left during a code review.
Path: fern/docs/pages/platform/actions/custom-names-descriptions.mdx
Line: 36
Comment:
**Absolute URL for internal link**
This is the only internal link in the entire docs codebase that uses an absolute `https://docs.credal.ai/...` URL. Every other internal cross-reference uses a root-relative path (e.g., `/user-guide/platform/...`). Using the hardcoded domain will silently break in staging, PR preview, or any environment not served from `docs.credal.ai`.
```suggestion
You can distribute and scale usage of your customized actions in any surface through our [custom MCP servers](/user-guide/platform/mcp-servers/overview). Your HR, Finance, Product, etc. team can then manage their own blessed set of tools for the entire organization to use.
```
How can I resolve this? If you propose a fix, please make it concise. |
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,23 @@ | ||
| # Monitoring Usage | ||
|
|
||
| Credal provides comprehensive monitoring capabilities to track how actions are being used across your organization. The monitoring dashboard gives you visibility into action invocations, execution patterns, and usage trends. | ||
|
|
||
|  | ||
|
|
||
| ## What You Can Monitor | ||
|
|
||
| - **Action Invocations**: See how often each action is being called by agents | ||
| - **Execution Success Rates**: Track which actions are completing successfully vs. failing | ||
| - **User Activity**: Understand which users and teams are leveraging different actions | ||
| - **Action Justifications**: Review business justifications provided by users when invoking sensitive actions, creating a complete audit trail for compliance and governance | ||
| - **Temporal Patterns**: Identify usage trends over time to optimize action configurations | ||
|
|
||
| ## Accessing Monitoring Data | ||
|
|
||
| To view action monitoring data: | ||
|
|
||
| 1. Navigate to the Actions section in the Credal platform | ||
| 2. Select the action you want to monitor | ||
| 3. Click on the **Monitoring** or **Usage** tab | ||
|
|
||
| The monitoring dashboard provides real-time insights to help you optimize action performance and governance. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,7 @@ | ||
| # Setting up Controls | ||
|
|
||
| For every MCP server, admins can enable or disable individual tools and require [human approval](/user-guide/platform/governed-actions/human-approval-options) before specific actions execute. If a third-party server exposes actions that are too sensitive or not relevant for your organization, simply turn them off. For actions you want to allow but monitor closely, approval enforcement ensures nothing runs without a human sign-off first. | ||
|
|
||
| <Note> | ||
| **Tool Syncing:** Credal automatically refreshes the list of available tools every time `tools/list` is called through the MCP gateway. You can also manually refresh tools using the refresh button in the UI. Background refreshes with version control to synchronously approve changes are coming soon, as well as the ability to enforce human approval on any of these actions. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Contradictory messaging about human approval availability The opening paragraph of this page already states that admins can "require human approval before specific actions execute" as a current feature. The new Note, however, ends with "…as well as the ability to enforce human approval on any of these actions" framed as a coming-soon item. A reader will reasonably interpret this as "human approval on MCP server actions is not yet available," which directly contradicts the sentence above. If the coming-soon item refers specifically to bulk / automatic enforcement (as opposed to per-action configuration), the Note should clarify that distinction to avoid confusion. Prompt To Fix With AIThis is a comment left during a code review.
Path: fern/docs/pages/platform/mcp-servers/import-server/setting-up-controls.mdx
Line: 6
Comment:
**Contradictory messaging about human approval availability**
The opening paragraph of this page already states that admins *can* "require human approval before specific actions execute" as a current feature. The new Note, however, ends with "…as well as the ability to enforce human approval on any of these actions" framed as a coming-soon item.
A reader will reasonably interpret this as "human approval on MCP server actions is not yet available," which directly contradicts the sentence above. If the coming-soon item refers specifically to *bulk / automatic* enforcement (as opposed to per-action configuration), the Note should clarify that distinction to avoid confusion.
How can I resolve this? If you propose a fix, please make it concise. |
||
| </Note> | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Internal hyperlinks removed from Security section
Two useful cross-links that were present in the previous version of this section were dropped in this PR:
detailed audit logspreviously linked to/user-guide/platform/administration/audit-log-data-exportsSSO and SCIM integrationpreviously linked to/user-guide/platform/administration/single-sign-on-ssoRestoring these helps users navigate to the relevant feature pages directly from the introduction, which is a common entry point. Consider adding them back:
Prompt To Fix With AI