single source of truth npm page (#1315)

Gaurav1998-dev · web-flow · commit 87956b253ad5 · 2025-12-17T13:25:21.000-08:00
diff --git a/agents-docs/content/docs/get-started/inkeep-mcp.mdx b/agents-docs/content/docs/get-started/inkeep-mcp.mdx
@@ -0,0 +1,47 @@
+---
+title: Install Inkeep MCP
+sidebarTitle: Inkeep MCP
+description: Install Inkeep MCP to enable AI coding assistants to "vibe code" with your Inkeep agents.
+icon: "brand/Inkeep"
+---
+If you didn't already opt-in to install the Inkeep MCP server during the interactive setup (`npx @inkeep/create-agents`), you can add the Inkeep MCP server to your preferred IDE. This enables AI coding assistants to "vibe code" with your Inkeep agents.
+
+### Cursor
+
+Click the button below to add the Inkeep MCP server to Cursor.
+
+<div style={{ display: "flex", flexDirection: "row", alignItems: "center", gap: "16px", justifyContent: "center" }}>
+<a href="cursor://anysphere.cursor-deeplink/mcp/install?name=inkeep-agents&config=eyJ1cmwiOiJodHRwczovL2FnZW50cy5pbmtlZXAuY29tL21jcCJ9">
+  <Image
+    src="https://cursor.com/deeplink/mcp-install-dark.png"
+    alt="Add to Cursor"
+    style={{ height: "36px", verticalAlign: "middle", marginTop: "10px", marginBottom: "10px" }}
+  />
+</a>
+</div>
+
+### VS Code
+
+Click the button below to add the Inkeep MCP server to VS Code.
+
+<div style={{ display: "flex", flexDirection: "row", alignItems: "center", gap: "16px", justifyContent: "center" }}>
+<a href="vscode:mcp/install?%7B%22name%22%3A%22inkeep-agents-mcp%22%2C%22type%22%3A%22sse%22%2C%22url%22%3A%22https%3A%2F%2Fagents.inkeep.com%2Fmcp%22%7D">
+  <Image
+    src="https://img.shields.io/badge/VS_Code-Install_Inkeep_MCP-0098FF?style=flat-square&logo=visualstudiocode&logoColor=ffffff"
+    alt="Install in VS Code"
+    style={{ height: "28px", verticalAlign: "middle", marginTop: "10px", marginBottom: "10px" }}
+  />
+</a>
+</div>
+
+### Claude Code
+
+To add to **Claude Code**, run this in your terminal:
+
+```bash
+claude mcp add --transport http inkeep-agents https://agents.inkeep.com/mcp --scope project
+```
+
+### Other MCP clients
+
+Manually add `https://agents.inkeep.com/mcp` as an MCP Server to any MCP client.
diff --git a/agents-docs/content/docs/get-started/meta.json b/agents-docs/content/docs/get-started/meta.json
@@ -1,5 +1,5 @@
 {
   "title": "Get Started",
   "icon": "LuZap",
-  "pages": ["quick-start", "push-pull", "traces", "..."]
+  "pages": ["quick-start", "push-pull", "traces", "inkeep-mcp", "..."]
 }
diff --git a/agents-docs/content/docs/get-started/quick-start.mdx b/agents-docs/content/docs/get-started/quick-start.mdx
@@ -4,123 +4,4 @@ description: Get started with Inkeep Agents in <1min
 icon: LuRocket
 ---
 
-## Launch your first agent
-
-### Prerequisites
-
-Before getting started, ensure you have the following installed on your system:
-
-- [Node.js](https://nodejs.org/en/download/) version 22 or higher
-- [Docker](https://docs.docker.com/get-docker/)
-- [pnpm](https://pnpm.io/installation) version 10 or higher
-
-You can verify by running:
-
-```bash
-node --version
-pnpm --version
-docker --version
-```
-
-### Step 1: Create a new agents project
-
-Run the quickstart script on a target folder:
-
-```bash
-npx @inkeep/create-agents my-agents
-```
-
-Navigate to the folder
-
-```bash
-cd my-agents
-```
-
-Open the folder using your coding editor. To open with Cursor, you can run `cursor .`
-
-### Step 2: Run the setup script
-
-Ensure Docker Desktop (or Docker daemon) is running before running the setup script.
-
-```bash
-pnpm setup-dev
-```
-
-Or if you are using a cloud database, you can skip the docker database startup by running:
-
-```bash
-pnpm setup-dev --skip-docker
-```
-
-Make sure your DATABASE_URL environment variable is configured for your cloud database.
-
-### Step 3: Launch the dev environment
-
-```bash
-pnpm dev
-```
-
-The Visual Builder will auto-open at http://localhost:3000.
-
-### Step 4: Chat with your agent
-
-Navigate to the **Activities Planner** agent at http://localhost:3000, click **Try it**, and ask about fun activities at a location of your choice:
-
-<Image src="/gifs/activities-planner.gif" alt="Chat with your agent" />
-
-### Step 5: Install Inkeep MCP (optional)
-
-If you didn't already opt-in to install the Inkeep MCP server during setup, you can add the Inkeep MCP server to your preferred IDE. This enables AI coding assistants to "vibe code" with your Inkeep agents.
-
-<div
-  style={{
-    display: "flex",
-    flexDirection: "row",
-    alignItems: "center",
-    gap: "16px",
-  }}
->
-  <a href="cursor://anysphere.cursor-deeplink/mcp/install?name=inkeep-agents&config=eyJ1cmwiOiJodHRwczovL2FnZW50cy5pbmtlZXAuY29tL21jcCJ9">
-    <Image
-      src="https://cursor.com/deeplink/mcp-install-dark.png"
-      alt="Add to Cursor"
-      style={{ height: "32px", verticalAlign: "middle" }}
-    />
-  </a>
-  <a href="vscode:mcp/install?%7B%22name%22%3A%22inkeep-agents-mcp%22%2C%22type%22%3A%22sse%22%2C%22url%22%3A%22https%3A%2F%2Fagents.inkeep.com%2Fmcp%22%7D">
-    <Image
-      src="https://img.shields.io/badge/VS_Code-Install_Inkeep_MCP-0098FF?style=flat-square&logo=visualstudiocode&logoColor=ffffff"
-      alt="Install in VS Code"
-      style={{ height: "22px", verticalAlign: "middle" }}
-    />
-  </a>
-</div>
-
-To add to **Claude Code**, run this in your terminal:
-
-```bash
-claude mcp add --transport http inkeep-agents https://agents.inkeep.com/mcp --scope project
-```
-
-Or manually add `https://agents.inkeep.com/mcp` as an MCP Server to any MCP client.
-
-### Next steps
-
-Next, we recommend learning about `inkeep push` and `inkeep pull` so you can go from `SDK -> Visual Builder` and `Visual Builder -> SDK`. See the [Push / Pull](/get-started/push-pull) guide for a quick example.
-
-<Cards>
-  <Card
-    title="Push / Pull"
-    icon="LuArrowLeftRight"
-    href="/get-started/push-pull"
-  >
-    Use our cookbook to learn about push and pull.
-  </Card>
-  <Card
-    title="Meeting prep agent"
-    icon="LuCalendar"
-    href="/tutorials/agents/meeting-prep-assistant"
-  >
-    Learn how to build a meeting prep agent using the Visual Builder.
-  </Card>
-</Cards>
+<Snippet file="https://raw.githubusercontent.com/inkeep/agents/refs/heads/main/packages/create-agents/README.md" />
diff --git a/agents-docs/next.config.ts b/agents-docs/next.config.ts
@@ -11,6 +11,14 @@ const config: NextConfig = {
   reactStrictMode: true,
   // Increase timeout for static page generation in CI environments
   staticPageGenerationTimeout: 120, // 2 minutes instead of default 60 seconds
+  images: {
+    remotePatterns: [
+      {
+        protocol: 'https',
+        hostname: 'docs.inkeep.com',
+      },
+    ],
+  },
   async redirects() {
     const cloudRedirects = await fetchCloudRedirects();
 
diff --git a/packages/create-agents/README.md b/packages/create-agents/README.md
@@ -1,149 +1,70 @@
-# create-agents
+## Launch your first agent
 
-Create an Inkeep Agent Framework directory with multi-service architecture.
+### Prerequisites
 
-## Quick Start
+Before getting started, ensure you have the following installed on your system:
 
-```bash
-# Interactive mode
-npx create-agents
+- [Node.js](https://nodejs.org/en/download/) version 22 or higher
+- [Docker](https://docs.docker.com/get-docker/)
+- [pnpm](https://pnpm.io/installation) version 10 or higher
 
-# With directory name
-npx create-agents my-agent-directory
+You can verify by running:
 
-# With options
-npx create-agents my-agent-directory  --project-id my-project --openai-key sk-... --anthropic-key sk-ant-...
+```bash
+node --version
+pnpm --version
+docker --version
 ```
 
-## Usage
+### Step 1: Create a new agents project
 
-`@inkeep/create-agents` is a wrapper around the Inkeep CLI's `create` command that sets up a complete Agent Framework directory with:
+Run the quickstart script on a target folder:
 
-### Interactive Mode
-Run without arguments for an interactive setup experience:
 ```bash
-npx create-agents
+npx @inkeep/create-agents my-agents
 ```
 
-You'll be prompted for:
-- Directory name
-- Tenant ID
-- Project ID  
-- Anthropic API key (recommended)
-- OpenAI API key (optional)
+Navigate to the folder
 
-### Direct Mode
-Specify options directly:
 ```bash
-pnpm create-agents my-agent-directory --project-id my-project-id --anthropic-key sk-ant-... --openai-key sk-...
+cd my-agents
 ```
 
-## Options
-
-- `--project-id <project-id>` - Project identifier for your agents
-- `--openai-key <openai-key>` - OpenAI API key (optional)
-- `--anthropic-key <anthropic-key>` - Anthropic API key (recommended)
+Open the folder using your coding editor. To open with Cursor, you can run `cursor .`
 
-## What's Created
+### Step 2: Run the setup script
 
-After running `@inkeep/create-agents`, you'll have a complete Agent Framework Directory:
+Ensure Docker Desktop (or Docker daemon) is running before running the setup script.
 
+```bash
+pnpm setup-dev
 ```
-my-agent-directory/
-├── src/
-│   └── <project-id>/           # Agent configurations
-│       ├── hello-agent.ts      # Example agent configuration
-│       ├── inkeep.config.ts    # Inkeep CLI configuration
-│       └── .env                # CLI environment variables
-├── apps/
-│   ├── manage-api/             # Manage API service
-│   │   ├── src/index.ts        # API server entry point
-│   │   ├── package.json        # Service dependencies
-│   │   ├── tsconfig.json       # TypeScript config
-│   │   └── .env                # Service environment
-│   ├── run-api/                # Run API service  
-│   │   ├── src/index.ts        # API server entry point
-│   │   ├── package.json        # Service dependencies
-│   │   ├── tsconfig.json       # TypeScript config
-│   │   └── .env                # Service environment
-│   └── shared/                 # Shared code
-│       └── credential-stores.ts # Credential store config
-├── package.json                # Root package with workspaces
-├── turbo.json                  # Turbo build configuration
-├── drizzle.config.ts           # Database configuration
-├── biome.json                  # Linting and formatting
-├── .env                        # Root environment variables
-├── .env.example                # Environment template
-├── .gitignore                  # Git ignore rules
-└── README.md                   # Project documentation
-```
-
-## Next Steps
-
-1. **Navigate to your directory:**
-   ```bash
-   cd my-agent-directory
-   ```
-
-2. **Start the services:**
-   ```bash
-   # Start both Manage API and Run API
-   pnpm dev
-   ```
-
-3. **In a new terminal, start the Manage UI:**
-   ```bash
-   inkeep dev
-   ```
 
-4. **Deploy your project:**
-   ```bash
-   cd src/<project-id>/
-   pnpm inkeep push
-   ```
+Or if you are using a cloud database, you can skip the docker database startup by running:
 
-## Available Services
-
-After setup, you'll have access to:
-
-- **Manage API** (Port 3002): Agent configuration and management
-- **Run API** (Port 3003): Agent execution and chat processing  
-- **Manage UI** (Port 3000): Visual agent builder (via `npx inkeep dev`)
-
-## Commands Available in Your Directory
-
-- `pnpm dev` - Start both API services with hot reload
-- `pnpm db:migrate` - Apply database migrations
-- `inkeep dev` - Start the Manage UI
-- `inkeep push` - Deploy project configurations
+```bash
+pnpm setup-dev --skip-docker
+```
 
-## Environment Variables
+Make sure your DATABASE_URL environment variable is configured for your cloud database.
 
-The directory includes multiple environment files:
+### Step 3: Launch the dev environment
 
-### Root `.env` (shared configuration)
 ```bash
-# AI Provider Keys
-ANTHROPIC_API_KEY=your-anthropic-key-here
-OPENAI_API_KEY=your-openai-key-here
+pnpm dev
+```
 
-# Service Ports
-MANAGE_API_PORT=3002
-RUN_API_PORT=3003
+The Visual Builder will auto-open at http://localhost:3000.
 
-# Database
-DATABASE_URL=your-pg-database-url-here
+### Step 4: Chat with your agent
 
-# Environment
-ENVIRONMENT=development
-LOG_LEVEL=debug
-```
+Navigate to the **Activities Planner** agent at http://localhost:3000 and ask about fun activities at a location of your choice:
 
-### Service-specific `.env` files
-- `apps/manage-api/.env` - Manage API configuration
-- `apps/run-api/.env` - Run API configuration  
-- `src/<project-id>/.env` - CLI configuration
+![Chat with your agent](https://docs.inkeep.com/gifs/activities-planner.gif) 
 
-## Learn More
+### Next steps
 
-- 📚 [Documentation](https://docs.inkeep.com)
+- Learn about [inkeep push / pull](https://docs.inkeep.com/get-started/push-pull) so you can go from `SDK -> Visual Builder` and `Visual Builder -> SDK`.
+- Follow our [meeting prep agent tutorial](https://docs.inkeep.com/tutorials/agents/meeting-prep-assistant) to create an agent using the Visual Builder.
+- Follow our [fact finder agent tutorial](https://docs.inkeep.com/tutorials/agents/fact-finder) to create an agent using the TypeScript SDK.
+- Install the [Inkeep MCP](https://docs.inkeep.com/get-started/inkeep-mcp) in your IDE to enable AI coding assistants to "vibe code" your Inkeep agents.

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"title": "Get Started",`
`3`	`3`	`"icon": "LuZap",`
`4`		`- "pages": ["quick-start", "push-pull", "traces", "..."]`
	`4`	`+ "pages": ["quick-start", "push-pull", "traces", "inkeep-mcp", "..."]`
`5`	`5`	`}`