Skip to content

Commit 6ff00b9

Browse files
Options mdx component + remove inkeep cloud ref (#2210)
* added pricing cards * made optioncards scalable * removed some cloud references * converted markdown images to img tags * removed references to inkeep cloud
1 parent 79df7cb commit 6ff00b9

File tree

25 files changed

+280
-171
lines changed

25 files changed

+280
-171
lines changed

agents-cli/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ The executable command is `inkeep`.
1616

1717
- CLI overview: <https://docs.inkeep.com/guides/cli/overview>
1818
- CLI reference: <https://docs.inkeep.com/typescript-sdk/cli-reference>
19-
- Push guide: <https://docs.inkeep.com/guides/cli/push-to-cloud>
20-
- Pull guide: <https://docs.inkeep.com/guides/cli/pull-from-cloud>
19+
- Push guide: <https://docs.inkeep.com/guides/cli/push-to-remote>
20+
- Pull guide: <https://docs.inkeep.com/guides/cli/pull-from-remote>
2121
- Profile setup: <https://docs.inkeep.com/guides/cli/setup-profile>
2222

2323
## Quick usage

agents-docs/content/deployment/inkeep-cloud/get-started.mdx renamed to agents-docs/content/deployment/inkeep-enterprise/get-started.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
---
2-
title: Get Started with Inkeep Cloud
2+
title: Get Started with Inkeep Enterprise
33
sidebarTitle: Get Started
4-
description: Get started with Inkeep Cloud
4+
description: Get started with Inkeep Enterprise
55
icon: LuZap
66
---
77

88
# Overview
99

10-
With Inkeep Cloud, we manage the infrastructure for you so you can focus on building your agents. In this guide, will walk you through the steps to build your first agent in the Inkeep Cloud Visual Builder.
10+
With Inkeep Enterprise, we manage the infrastructure for you so you can focus on building your agents. In this guide, will walk you through the steps to build your first agent in the Inkeep Enterprise Visual Builder.
1111

1212
### Prerequisites
1313

14-
- An Inkeep Cloud account - if you don't have one, you can sign up for the [waitlist](https://inkeep.com/cloud-waitlist)
14+
- An Inkeep Enterprise account - if you don't have one, you can sign up for the [demo](https://inkeep.com/demo?cta_id=docs_nav)
1515

1616
### Step 1: Login using your credentials
1717

18-
<img src="/images/inkeep-cloud-login.png" alt="Inkeep Cloud Login" width="600" style={{ borderRadius: '8px' }} />
18+
<img src="/images/inkeep-cloud-login.png" alt="Inkeep Cloud Enterprise Login" width="600" style={{ borderRadius: '8px' }} />
1919

2020
### Step 2: Enter a project
2121

22-
Once you're logged in, you'll be redirected to the Inkeep Cloud project overview page. If you are part of a team, you might see a list of existing projects like this:
22+
Once you're logged in, you'll be redirected to the Inkeep Enterprise project overview page. If you are part of a team, you might see a list of existing projects like this:
2323

24-
![Inkeep Cloud Project Overview](/images/inkeep-cloud-project-overview.png)
24+
<img src="/images/inkeep-cloud-project-overview.png" alt="Inkeep Cloud Project Overview" style={{ borderRadius: '8px' }} />
2525

2626
If you are part of a team, click into the project your team has created. If you are not part of a team, you can create a new project by clicking the "Create Project" button.
2727

2828
### Step 3: Inspect the project
2929

3030
Once you're in the project, you'll see the project overview page. You can see the list of agents that are part of the project.
3131

32-
![Inkeep Cloud Agent Overview](/images/inkeep-cloud-agent-overview.png)
32+
<img src="/images/inkeep-cloud-agent-overview.png" alt="Inkeep Cloud Agent Overview" style={{ borderRadius: '8px' }} />
3333

3434
In the MCP Servers section, you can see the list of MCP servers that are part of the project:
3535

36-
![Inkeep Cloud MCP Servers](/images/inkeep-cloud-mcp-overview.png)
36+
<img src="/images/inkeep-cloud-mcp-overview.png" alt="Inkeep Cloud MCP Servers" style={{ borderRadius: '8px' }} />
3737

3838
<Tip title="MCP Servers">
3939
MCP servers are the tools that your agents can use to interact with external APIs and services.
@@ -49,7 +49,7 @@ Back in the agent overview page, click the "Create Agent" button to create a new
4949

5050
Inkeep will prompt you to build your agent using natural language. Let's ask Inkeep to build a knowledge agent that can answer questions about your knowledge base:
5151

52-
![Inkeep Cloud Create Agent](/images/inkeep-cloud-chat-to-edit.png)
52+
<img src="/images/inkeep-cloud-chat-to-edit.png" alt="Inkeep Cloud Create Agent" style={{ borderRadius: '8px' }} />
5353

5454
### Step 5: Try the agent
5555

@@ -69,7 +69,7 @@ You can edit your agent by dragging and dropping new sub agents and tools onto t
6969
<Card
7070
title="Understand MCP Server Scopes"
7171
icon="LuUsers"
72-
href="/deployment/inkeep-cloud/user-vs-project-mcp"
72+
href="/deployment/inkeep-enterprise/user-vs-project-mcp"
7373
>
7474
Learn about user-level vs project-level MCP servers and how they affect your team workflow.
7575
</Card>

agents-docs/content/deployment/inkeep-cloud/meta.json renamed to agents-docs/content/deployment/inkeep-enterprise/meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"title": "Inkeep Cloud",
2+
"title": "Inkeep Enterprise",
33
"icon": "LuCloud",
44
"pages": ["get-started", "user-vs-project-mcp", "..."]
55
}

agents-docs/content/deployment/inkeep-cloud/user-vs-project-mcp.mdx renamed to agents-docs/content/deployment/inkeep-enterprise/user-vs-project-mcp.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ keywords: MCP servers, user-level, project-level, authentication, team collabora
88

99
## Overview
1010

11-
When [creating a new MCP server](/visual-builder/tools/mcp-servers) in the Inkeep Cloud Visual Builder, you can choose to configure it at the user-level or project-level.
11+
When [creating a new MCP server](/visual-builder/tools/mcp-servers) in the Inkeep Visual Builder, you can choose to configure it at the user-level or project-level.
1212

1313
Understanding the difference between these two types is important for managing your team's access to agents and their associated tools.
1414

1515
## User-Level MCP Servers
1616

1717
User-level MCP servers are configured per individual user. When you create a user-level MCP server, each team member must authenticate with their own credentials to use the associated tools.
1818

19-
![Inkeep Cloud User-Level MCP Server](/images/user-scope-mcp.png)
19+
<img src="/images/user-scope-mcp.png" alt="Inkeep Cloud User-Level MCP Server" style={{ borderRadius: '8px' }} />
2020

2121
### Benefits
2222

@@ -34,7 +34,7 @@ User-level MCP servers are configured per individual user. When you create a use
3434

3535
Project-level MCP servers use shared credentials that are configured at the project level. All team members in the project can use these servers without individual authentication.
3636

37-
![Inkeep Cloud Project-Level MCP Server](/images/project-scope-mcp.png)
37+
<img src="/images/project-scope-mcp.png" alt="Inkeep Cloud Project-Level MCP Server" style={{ borderRadius: '8px' }} />
3838

3939
### Benefits
4040

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"icon": "LuServer",
3-
"pages": ["inkeep-cloud", "vercel", "(docker)", "add-other-services", "..."]
3+
"pages": ["inkeep-enterprise", "vercel", "(docker)", "add-other-services", "..."]
44
}

agents-docs/content/deployment/vercel.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Sign up for a Vercel account [here](https://vercel.com/signup).
3535

3636
### Step 6: Create a Vercel project for Manage API
3737

38-
![Vercel New Project - Manage API](/images/vercel-new-project-manage-api-hono.png)
38+
<img src="/images/vercel-new-project-manage-api-hono.png" alt="Vercel New Project - Manage API" style={{ borderRadius: '8px' }} />
3939

4040
<Note>
4141
The Framework Preset should be "Hono" and the Root Directory should be
@@ -69,7 +69,7 @@ NANGO_SERVER_URL=https://api.nango.dev
6969

7070
### Step 7: Create a Vercel project for Run API
7171

72-
![Vercel New Project - Run API](/images/vercel-new-project-run-api-hono.png)
72+
<img src="/images/vercel-new-project-run-api-hono.png" alt="Vercel New Project - Run API" style={{ borderRadius: '8px' }} />
7373

7474
<Note>
7575
The Framework Preset should be "Hono" and the Root Directory should be
@@ -115,7 +115,7 @@ INKEEP_AGENTS_JWT_SIGNING_SECRET=
115115

116116
### Step 8: Create a Vercel project for Manage UI
117117

118-
![Vercel New Project - Manage UI](/images/vercel-new-project-manage-ui-nextjs.png)
118+
<img src="/images/vercel-new-project-manage-ui-nextjs.png" alt="Vercel New Project - Manage UI" style={{ borderRadius: '8px' }} />
119119

120120
<Note>
121121
The Framework Preset should be "Next.js" and the Root Directory should be
@@ -162,7 +162,7 @@ To prevent anyone from being able to access the UI, we recommend enabling Vercel
162162

163163
### Step 10: Create a Vercel project for your MCP server (optional)
164164

165-
![Vercel New Project - MCP Server](/images/vercel-new-project-mcp.png)
165+
<img src="/images/vercel-new-project-mcp.png" alt="Vercel New Project - MCP Server" style={{ borderRadius: '8px' }} />
166166

167167
<Note>
168168
The Framework Preset should be "Next.js" and the Root Directory should be

agents-docs/content/guides/agents/fact-finder.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In this tutorial, you'll build a fact finder agent using code and the Inkeep SDK
1818
## Prerequisites
1919

2020
- An existing Inkeep project running (follow the [quick start guide](/get-started/quick-start) to get started)
21-
- Or access to Inkeep Cloud
21+
- Or access to Inkeep Enterprise
2222

2323
## Setting up the project
2424

agents-docs/content/guides/agents/meeting-prep-assistant.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ In this tutorial, you'll build a meeting prep assistant agent using the Inkeep V
1919
## Prerequisites
2020

2121
- An existing Inkeep Visual Builder instance running (follow the [quick start guide](/get-started/quick-start) to get started)
22-
- Or access to Inkeep Cloud
22+
- Or access to Inkeep Enterprise
2323

2424
## Creating the Sub Agents
2525

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"title": "CLI",
33
"icon": "LuTerminal",
4-
"pages": ["overview", "setup-profile", "push-to-cloud", "pull-from-cloud", "..."]
4+
"pages": ["overview", "setup-profile", "push-to-remote", "pull-from-remote", "..."]
55
}

agents-docs/content/guides/cli/overview.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ description: Learn how to use the Inkeep CLI for common workflows
55
icon: LuTerminal
66
---
77

8-
The Inkeep CLI is your primary tool for managing agents, syncing configurations, and deploying to Inkeep Cloud. These tutorials walk you through common CLI workflows.
8+
The Inkeep CLI is your primary tool for managing your Inkeep agents and MCP servers. These guides walk you through common CLI workflows.
99

1010
## What you'll learn
1111

1212
<Cards>
1313
<Card title="Set Up a CLI Profile" icon="LuUserCog" href="/guides/cli/setup-profile">
14-
Create a profile and authenticate with a remote deployment (only needed for cloud push/pull)
14+
Create a profile and authenticate with a remote deployment (only needed for remote push/pull)
1515
</Card>
16-
<Card title="Push to Inkeep Cloud" icon="LuCloudUpload" href="/guides/cli/push-to-cloud">
17-
Push your local agent configurations to Inkeep Cloud
16+
<Card title="Push to Remote" icon="LuCloudUpload" href="/guides/cli/push-to-remote">
17+
Push your local agent configurations to remote Inkeep instance
1818
</Card>
19-
<Card title="Pull from Inkeep Cloud" icon="LuCloudDownload" href="/guides/cli/pull-from-cloud">
20-
Pull agent configurations from Inkeep Cloud to your local project
19+
<Card title="Pull from Remote" icon="LuCloudDownload" href="/guides/cli/pull-from-remote">
20+
Pull agent configurations from remote Inkeep instance to your local project
2121
</Card>
2222
</Cards>
2323

@@ -31,7 +31,7 @@ Before starting these tutorials, ensure you have:
3131
npm install -g @inkeep/agents-cli
3232
```
3333

34-
- Access to [Inkeep Cloud](https://inkeep.com/cloud-waitlist) or a [self-hosted deployment](/deployment/vercel)
34+
- Access to a remote Inkeep instance (e.g. [Inkeep Enterprise](https://inkeep.com/enterprise?cta_id=docs_nav) or a [self-hosted deployment](/deployment/vercel))
3535

3636
## Quick reference
3737

0 commit comments

Comments
 (0)