+
Skip to content

done #193

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

done #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 24 additions & 34 deletions agents-docs/content/docs/talk-to-your-agents/mcp-server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,6 @@ icon: "LuServer"

The MCP server allows you to talk to your agents through the Model Context Protocol.

## MCP Server Implementation

The MCP server is implemented in the `@inkeep/agents-run-api` library and provides a standard interface for agent communication.

## Available Tools

The MCP server exposes one core tool:

### send-query-to-agent

Sends a query to your agent graph's default agent. This tool:

- **Name**: `send-query-to-agent`
- **Description**: Dynamically generated based on your agent graph's name and description
- **Parameters**:
- `query` (string): The query to send to the agent
- **Returns**: The agent's response as text content

**Example usage in Cursor:**
When the MCP server is configured, Cursor will automatically discover this tool and you can use it by asking questions. The tool will route your query to the appropriate agent in your graph and return the response.

The tool handles:

- Message creation and conversation management
- Agent execution with your configured tools and capabilities
- Context resolution if your graph has context configuration
- Error handling and response formatting

## Using with Cursor

Add the following configuration to your Cursor MCP settings:
Expand All @@ -44,7 +16,7 @@ Add the following configuration to your Cursor MCP settings:
{
"AgentName": {
"type": "mcp",
"url": "http://<your-run-api-url>/v1/mcp",
"url": "http://<your-run-api-url>/v1/mcp", // Default: http://localhost:3003/v1/mcp for local development
"headers": {
"Authorization": "Bearer <api-key>",
"x-inkeep-tenant-id": "your-tenant-id",
Expand All @@ -63,7 +35,7 @@ When `agents-run-api` is running with `ENVIRONMENT=development`, authentication
{
"BasicFactAgent": {
"type": "mcp",
"url": "http://<your-run-api-url>/v1/mcp",
"url": "http://<your-run-api-url>/v1/mcp", // Default: http://localhost:3003/v1/mcp for local development
"headers": {
"x-inkeep-tenant-id": "inkeep",
"x-inkeep-project-id": "default",
Expand All @@ -73,8 +45,26 @@ When `agents-run-api` is running with `ENVIRONMENT=development`, authentication
}
```

## Configuration Notes
## Available Tools

The MCP server exposes one core tool:

### send-query-to-agent

Sends a query to your agent graph's default agent. This tool:

- **URL**: Point to your `agents-run-api` instance (default: `http://localhost:3003`)
- **Headers**: Required scope headers for identifying the tenant, project, and graph
- **Authorization**: Only required when not in development mode
- **Name**: `send-query-to-agent`
- **Description**: Dynamically generated based on your agent graph's name and description
- **Parameters**:
- `query` (string): The query to send to the agent
- **Returns**: The agent's response as text content

**Example usage in Cursor:**
When the MCP server is configured, Cursor will automatically discover this tool and you can use it by asking questions. The tool will route your query to the appropriate agent in your graph and return the response.

The tool handles:

- Message creation and conversation management
- Agent execution with your configured tools and capabilities
- Context resolution if your graph has context configuration
- Error handling and response formatting
18 changes: 13 additions & 5 deletions agents-docs/content/docs/talk-to-your-agents/react/chat-button.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,19 @@ icon: "LuMessageCircle"

The chat button component is a simple way to trigger the Inkeep modal.

<Tabs>
<Tab title="npm">```bash npm install @inkeep/cxkit-react-oss ```</Tab>
<Tab title="yarn">```bash yarn add @inkeep/cxkit-react-oss ```</Tab>
<Tab title="pnpm">```bash pnpm add @inkeep/cxkit-react-oss ```</Tab>
</Tabs>
<CodeGroup>
```bash title="npm"
npm install @inkeep/cxkit-react-oss
```

```bash title="yarn"
yarn add @inkeep/cxkit-react-oss
```

```bash title="pnpm"
pnpm add @inkeep/cxkit-react-oss
```
</CodeGroup>

```tsx
import {
Expand Down
18 changes: 13 additions & 5 deletions agents-docs/content/docs/talk-to-your-agents/react/custom-trigger.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,19 @@ Custom triggers give you complete control over how users open Inkeep modals in y

## Installation

<Tabs>
<Tab title="npm">```bash npm install @inkeep/cxkit-react-oss ```</Tab>
<Tab title="yarn">```bash yarn add @inkeep/cxkit-react-oss ```</Tab>
<Tab title="pnpm">```bash pnpm add @inkeep/cxkit-react-oss ```</Tab>
</Tabs>
<CodeGroup>
```bash title="npm"
npm install @inkeep/cxkit-react-oss
```

```bash title="yarn"
yarn add @inkeep/cxkit-react-oss
```

```bash title="pnpm"
pnpm add @inkeep/cxkit-react-oss
```
</CodeGroup>

## Quick Start

Expand Down
18 changes: 13 additions & 5 deletions agents-docs/content/docs/talk-to-your-agents/react/embedded-chat.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,19 @@ The InkeepEmbeddedChat component provides a fully embedded chat interface that y

## Installation

<Tabs>
<Tab title="npm">```bash npm install @inkeep/cxkit-react-oss ```</Tab>
<Tab title="yarn">```bash yarn add @inkeep/cxkit-react-oss ```</Tab>
<Tab title="pnpm">```bash pnpm add @inkeep/cxkit-react-oss ```</Tab>
</Tabs>
<CodeGroup>
```bash title="npm"
npm install @inkeep/cxkit-react-oss
```

```bash title="yarn"
yarn add @inkeep/cxkit-react-oss
```

```bash title="pnpm"
pnpm add @inkeep/cxkit-react-oss
```
</CodeGroup>

## Basic Implementation

Expand Down
18 changes: 13 additions & 5 deletions agents-docs/content/docs/talk-to-your-agents/react/side-bar-chat.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,19 @@ The InkeepSidebarChat component provides a slide-out panel interface for convers

## Installation

<Tabs>
<Tab title="npm">```bash npm install @inkeep/cxkit-react-oss ```</Tab>
<Tab title="yarn">```bash yarn add @inkeep/cxkit-react-oss ```</Tab>
<Tab title="pnpm">```bash pnpm add @inkeep/cxkit-react-oss ```</Tab>
</Tabs>
<CodeGroup>
```bash title="npm"
npm install @inkeep/cxkit-react-oss
```

```bash title="yarn"
yarn add @inkeep/cxkit-react-oss
```

```bash title="pnpm"
pnpm add @inkeep/cxkit-react-oss
```
</CodeGroup>

## Trigger through react state

Expand Down
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载