Skip to content

Commit 5901590

Browse files
committed
Sync open source content 🐝 (from 279db2c75b88753a3744c6359ea32608d5bf4243)
1 parent c981138 commit 5901590

108 files changed

Lines changed: 574 additions & 510 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_meta.global.tsx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -713,13 +713,13 @@ const meta = {
713713
},
714714
},
715715
"why-gram": {
716-
title: "Why Gram?",
716+
title: "Why the AI Control Plane?",
717717
},
718718
"getting-started": {
719719
title: "Getting started",
720720
items: {
721721
typescript: {
722-
title: "Use TypeScript (Gram Functions)",
722+
title: "Use TypeScript (Speakeasy Functions)",
723723
},
724724
openapi: {
725725
title: "Use an OpenAPI spec",
@@ -960,7 +960,7 @@ const meta = {
960960
title: "Add OAuth to MCP servers",
961961
},
962962
"add-oauth-functions": {
963-
title: "Add OAuth to Gram Functions",
963+
title: "Add OAuth to Speakeasy Functions",
964964
},
965965
"oauth-proxy-for-internal-servers": {
966966
title: "OAuth proxy for internal servers",
@@ -1002,10 +1002,10 @@ const meta = {
10021002
},
10031003
},
10041004
"agents-api": {
1005-
title: "Gram Agents API (Beta)",
1005+
title: "Agents API (Beta)",
10061006
items: {
10071007
overview: {
1008-
title: "Gram Agents API overview",
1008+
title: "Agents API overview",
10091009
},
10101010
"billing-and-usage": {
10111011
title: "Billing and usage",

‎docs/ai-control-plane/getting-started/index.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ next:
1010
import { Callout } from "@/mdx/components";
1111

1212
<Callout title="Built in the open" type="info">
13-
The AI Control Plane is backed by [Gram](https://github.com/speakeasy-api/gram), an open source project maintained by the Speakeasy team. The project name still appears in the `gram` CLI, the `@gram-ai/*` packages, and `getgram.ai` URLs.
13+
The AI Control Plane is backed by an [open source project](https://github.com/speakeasy-api/gram) maintained by the Speakeasy team.
1414
</Callout>
1515

1616
This guide gets an organization from sign-in to a governed AI rollout: connect the identity provider, turn on logging, point Claude and the other agent platforms at the platform, distribute MCP servers to the team, and turn on security policies, then watch live traffic confirm it is all working. The work happens on the organization setup board, reached from **Finish organization setup** at the bottom of the organization sidebar.
@@ -23,7 +23,7 @@ This guide gets an organization from sign-in to a governed AI rollout: connect t
2323

2424
## The setup board
2525

26-
After [signing up](https://login.speakeasy.com/sign-up?state=return_url%3Dhttps%253A%252F%252Fapp.getgram.ai%252Frpc%252Fauth.callback%26speakeasy_as_provider%3Dtrue%26state%3DeyJmaW5hbF9kZXN0aW5hdGlvbl91cmwiOiIvIn0&redirect_uri=https%3A%2F%2Fapp.speakeasy.com%2Fv1%2Fauth%2Fcallback) or [logging in](https://login.speakeasy.com/?client_id=client_01J0XGGZ8MEQS57C5RKB00KN35&redirect_uri=https%3A%2F%2Fapp.speakeasy.com%2Fv1%2Fauth%2Fcallback), the **Organization setup** board guides organization admins through rollout. The **Start enterprise rollout** card on the organization home page (**Begin rollout**, or **Resume rollout** once started) and the **Finish organization setup** action at the bottom of the organization sidebar both lead there, and the board is always available at the organization's `/setup` path.
26+
After [signing up](https://login.speakeasy.com/sign-up?state=return_url%3Dhttps%253A%252F%252Fai.speakeasy.com%252Frpc%252Fauth.callback%26speakeasy_as_provider%3Dtrue%26state%3DeyJmaW5hbF9kZXN0aW5hdGlvbl91cmwiOiIvIn0&redirect_uri=https%3A%2F%2Fapp.speakeasy.com%2Fv1%2Fauth%2Fcallback) or [logging in](https://login.speakeasy.com/?client_id=client_01J0XGGZ8MEQS57C5RKB00KN35&redirect_uri=https%3A%2F%2Fapp.speakeasy.com%2Fv1%2Fauth%2Fcallback), the **Organization setup** board guides organization admins through rollout. The **Start enterprise rollout** card on the organization home page (**Begin rollout**, or **Resume rollout** once started) and the **Finish organization setup** action at the bottom of the organization sidebar both lead there, and the board is always available at the organization's `/setup` path.
2727

2828
Each outcome is a card. Cards move across four columns, **To do**, **In progress**, **Awaiting support**, and **Done**, by drag and drop or from the card menu. Opening a card lands on its own page at a short slug (`/setup/idp`, `/setup/anthropic-observability`, and so on), with a rail of that card's own steps, one on screen at a time, a **Get support** button, and **Mark done** at the end. The board remembers each card's status and owner, so the work can be split across admins and picked up later. The **Wizard** view in the header walks the same cards front to back for a single owner who wants to finish in one sitting.
2929

@@ -35,7 +35,7 @@ Each outcome is a card. Cards move across four columns, **To do**, **In progress
3535

3636
Three steps recur across cards. Each one is completed once and then shows as done wherever it appears.
3737

38-
**Enable logging** turns on **Enable Logs**, **Record Tool I/O**, and **Agent Session Capture** together, with a retention banner and a link to [**Organization settings > Settings > Logging & Telemetry**](https://app.getgram.ai/@self/logs) for the remaining options. Nothing downstream can show traffic until this is on. See [Logging and telemetry](/docs/ai-control-plane/org-admin/logging-and-telemetry).
38+
**Enable logging** turns on **Enable Logs**, **Record Tool I/O**, and **Agent Session Capture** together, with a retention banner and a link to [**Organization settings > Settings > Logging & Telemetry**](https://ai.speakeasy.com/@self/logs) for the remaining options. Nothing downstream can show traffic until this is on. See [Logging and telemetry](/docs/ai-control-plane/org-admin/logging-and-telemetry).
3939

4040
**Publish plugin marketplace** publishes a private GitHub repository that acts as the team's plugin marketplace for Claude Code, Cursor, and Codex. It ships with the core observability plugin, which collects usage metrics and enforces authorization, and any plugins built later publish there too. This happens once per project. Add at least one member of the GitHub organization as a collaborator so the repository is discoverable inside agent platforms; the collaborators become admins on the repository so they can connect it to Cursor, Claude, and other marketplaces. See [Plugins](/docs/ai-control-plane/mcp-gateway/plugins).
4141

@@ -47,7 +47,7 @@ Three steps recur across cards. Each one is completed once and then shows as don
4747

4848
### Set up identity provider
4949

50-
Connect the SSO provider so the team signs in with existing credentials, then sync its directory so users, groups, and roles stay in step with the identity provider. Both can be finished later from [**Organization settings > Team > IDP and SSO**](https://app.getgram.ai/@self/identity); see [IDP and SSO](/docs/ai-control-plane/org-admin/identity). Once people are signing in, the [Identity](/docs/ai-control-plane/identity) section is where every agent session gets tied to a person, an agent, or a remote identity provider.
50+
Connect the SSO provider so the team signs in with existing credentials, then sync its directory so users, groups, and roles stay in step with the identity provider. Both can be finished later from [**Organization settings > Team > IDP and SSO**](https://ai.speakeasy.com/@self/identity); see [IDP and SSO](/docs/ai-control-plane/org-admin/identity). Once people are signing in, the [Identity](/docs/ai-control-plane/identity) section is where every agent session gets tied to a person, an agent, or a remote identity provider.
5151

5252
**Single sign-on**: pick the organization's SSO provider (Okta, Entra ID, Google Workspace, OneLogin, JumpCloud, PingFederate, and more) and click **Connect**. The WorkOS portal opens in a new tab to configure the connection. Finish there, then return and click **Verify connection**.
5353

@@ -80,7 +80,7 @@ Claude Cowork and Claude Code are both configured from Claude.ai: organization p
8080

8181
![Per-platform manual setup entries for connecting coding assistants](/assets/docs/ai-control-plane/getting-started/setup-instrument-agents-manual.webp)
8282

83-
**Confirm traffic** completes after any tool runs in Claude Code or Cursor, or a Cowork session starts. The observability plugin's hooks run inside a Cowork session, not in an ordinary Claude conversation: on claude.ai, start a new conversation, switch the **Claude Cowork** toggle on, then send a message. The same per-platform instructions are available later from [**MCP Gateway > Plugins**](https://app.getgram.ai/@self/projects/default/plugins); see [Distributing plugins to Anthropic](/docs/ai-control-plane/mcp-gateway/plugins/anthropic).
83+
**Confirm traffic** completes after any tool runs in Claude Code or Cursor, or a Cowork session starts. The observability plugin's hooks run inside a Cowork session, not in an ordinary Claude conversation: on claude.ai, start a new conversation, switch the **Claude Cowork** toggle on, then send a message. The same per-platform instructions are available later from [**MCP Gateway > Plugins**](https://ai.speakeasy.com/@self/projects/default/plugins); see [Distributing plugins to Anthropic](/docs/ai-control-plane/mcp-gateway/plugins/anthropic).
8484

8585
### Set up observability in other platforms
8686

@@ -99,23 +99,23 @@ Neither OpenCode nor OpenClaw has a plugin marketplace, so the observability plu
9999

100100
### Set up LiteLLM
101101

102-
Point a LiteLLM proxy at the platform so its traffic is scanned by risk policies and lands in observability. The card is hidden by default. Its steps, **Create a LiteLLM instance**, **Configure the proxy**, and **Confirm traffic**, are driven by the instance itself, so they match what [**Organization settings > Settings > AI Integrations**](https://app.getgram.ai/@self/ai-integrations) shows. See [LiteLLM](/docs/ai-control-plane/org-admin/ai-integrations/litellm).
102+
Point a LiteLLM proxy at the platform so its traffic is scanned by risk policies and lands in observability. The card is hidden by default. Its steps, **Create a LiteLLM instance**, **Configure the proxy**, and **Confirm traffic**, are driven by the instance itself, so they match what [**Organization settings > Settings > AI Integrations**](https://ai.speakeasy.com/@self/ai-integrations) shows. See [LiteLLM](/docs/ai-control-plane/org-admin/ai-integrations/litellm).
103103

104104
### Configure integrations
105105

106-
Optionally connect admin and compliance APIs so the platform can import usage, spend, and review data across agent platforms: the Cursor Admin API, the Anthropic Compliance API, and the OpenAI Compliance Logs API. This step is optional. Add or edit provider keys later from [**Organization settings > Settings > AI Integrations**](https://app.getgram.ai/@self/ai-integrations); see [AI integrations](/docs/ai-control-plane/org-admin/ai-integrations).
106+
Optionally connect admin and compliance APIs so the platform can import usage, spend, and review data across agent platforms: the Cursor Admin API, the Anthropic Compliance API, and the OpenAI Compliance Logs API. This step is optional. Add or edit provider keys later from [**Organization settings > Settings > AI Integrations**](https://ai.speakeasy.com/@self/ai-integrations); see [AI integrations](/docs/ai-control-plane/org-admin/ai-integrations).
107107

108108
![The Additional agent configuration step with Cursor, Anthropic, and OpenAI provider connections](/assets/docs/ai-control-plane/getting-started/setup-additional-agent-configuration.webp)
109109

110110
### Distribute MCP servers
111111

112-
Choose MCP servers from the catalog to roll out to the organization. Selected servers deploy to the project, bundle into the default plugin, and publish to the marketplace so the team can install them. The card is hidden by default; the same rollout is available any time from [**MCP Gateway > MCP**](https://app.getgram.ai/@self/projects/default/mcp), described in [MCP Gateway](/docs/ai-control-plane/mcp-gateway) and the [catalog](/docs/ai-control-plane/mcp-gateway/catalog).
112+
Choose MCP servers from the catalog to roll out to the organization. Selected servers deploy to the project, bundle into the default plugin, and publish to the marketplace so the team can install them. The card is hidden by default; the same rollout is available any time from [**MCP Gateway > MCP**](https://ai.speakeasy.com/@self/projects/default/mcp), described in [MCP Gateway](/docs/ai-control-plane/mcp-gateway) and the [catalog](/docs/ai-control-plane/mcp-gateway/catalog).
113113

114114
![The Distribute MCP servers step with a searchable catalog of servers to distribute](/assets/docs/ai-control-plane/getting-started/setup-distribute-mcp-servers.webp)
115115

116116
### Configure policies
117117

118-
Pick what to flag or block in agent traffic. Shadow MCP enforcement forces every MCP tool call through the control plane, so unmanaged servers are blocked and RBAC, authorization, and audit trails stay enforced. Each detection category (secrets, personal identifiable information, prompt injection, financial information, and more) can flag or block on a finding. The card is hidden by default. Refine actions, message scopes, and individual rules any time from [**Security and Policy > Guardrails**](https://app.getgram.ai/@self/projects/default/risk-policies); see [Guardrails](/docs/ai-control-plane/secure/guardrails).
118+
Pick what to flag or block in agent traffic. Shadow MCP enforcement forces every MCP tool call through the control plane, so unmanaged servers are blocked and RBAC, authorization, and audit trails stay enforced. Each detection category (secrets, personal identifiable information, prompt injection, financial information, and more) can flag or block on a finding. The card is hidden by default. Refine actions, message scopes, and individual rules any time from [**Security and Policy > Guardrails**](https://ai.speakeasy.com/@self/projects/default/risk-policies); see [Guardrails](/docs/ai-control-plane/secure/guardrails).
119119

120120
![The Configure policies step with shadow MCP enforcement and detection categories](/assets/docs/ai-control-plane/getting-started/setup-configure-policies.webp)
121121

0 commit comments

Comments
 (0)