diff --git a/docs/ecosystem/ai-tools.mdx b/docs/ecosystem/ai-tools.mdx new file mode 100644 index 000000000..cedec253f --- /dev/null +++ b/docs/ecosystem/ai-tools.mdx @@ -0,0 +1,147 @@ +--- +id: ai-tools +title: AI Tools +--- + +Ory provides tools to help AI coding assistants query Ory documentation and work effectively with Ory codebases. + +## Ory Docs MCP Server + +The Ory Docs MCP server lets AI assistants query Ory's documentation directly. Connect it to your AI tool of choice using the +instructions below. + +### Cursor + +Add the following to your `.cursor/mcp.json` file: + +```json +{ + "mcpServers": { + "ory-docs": { + "type": "http", + "url": "https://ory-docs.mcp.kapa.ai" + } + } +} +``` + +For more information, see the [Cursor MCP documentation](https://docs.cursor.com/context/model-context-protocol). + +### Claude Code + +```bash +claude mcp add --transport http ory-docs https://ory-docs.mcp.kapa.ai +``` + +Then run the `/mcp` command in Claude Code and follow the steps in your browser to authenticate. + +For more information, see the [Claude Code MCP documentation](https://docs.anthropic.com/en/docs/claude-code/mcp). + +### Claude Desktop + +Add the following to your Claude Desktop configuration: + +```json +{ + "mcpServers": { + "ory-docs": { + "command": "npx", + "args": ["mcp-remote", "https://ory-docs.mcp.kapa.ai"] + } + } +} +``` + +### VS Code + +Prerequisites: VS Code 1.102+ with GitHub Copilot enabled. + +Create an `mcp.json` file in your workspace `.vscode` folder: + +```json title=".vscode/mcp.json" +{ + "servers": { + "ory-docs": { + "type": "http", + "url": "https://ory-docs.mcp.kapa.ai" + } + } +} +``` + +For more details, see the [VS Code MCP documentation](https://code.visualstudio.com/docs/copilot/customization/mcp-servers). + +### ChatGPT Desktop + +ChatGPT Desktop supports MCP servers in developer mode: + +1. Open ChatGPT Desktop. +1. Go to **Settings > Features**. +1. Enable **Developer mode**. +1. Navigate to **Settings > MCP Servers**. +1. Click **Add Server** and enter: + - Name: `ory-docs` + - URL: `https://ory-docs.mcp.kapa.ai` + +For more information, see the [ChatGPT Desktop MCP documentation](https://platform.openai.com/docs/guides/developer-mode). + +### Other + +MCP is an open protocol supported by many clients. Use the server URL `https://ory-docs.mcp.kapa.ai` and refer to your client's +documentation for setup instructions. + +Most clients accept the standard MCP JSON configuration format: + +```json +{ + "mcpServers": { + "ory-docs": { + "url": "https://ory-docs.mcp.kapa.ai" + } + } +} +``` + +## Ory Claude Plugins + +The [Ory Claude Plugins](https://github.com/ory/claude-plugins) repository is the official Claude Code plugin marketplace for Ory. +Install it in Claude Code with: + +```bash +/plugin marketplace add ory/claude-plugins +``` + +This gives you access to all Ory plugins for Claude Code, including Lumen (see below). + +## Lumen + +[Lumen](https://github.com/ory/lumen) is a fully local semantic code search engine for AI coding agents. Instead of reading entire +files, Claude uses Lumen's `semantic_search` tool to find relevant functions and types by meaning — reducing cost and session time +without sacrificing quality. + +**Install via the Ory Claude Plugins:** + +```bash +/plugin marketplace add ory/claude-plugins +/plugin install lumen@ory +``` + +On first session start, Lumen indexes your project in the background and registers a `semantic_search` MCP tool that Claude uses +automatically. + +**Prerequisites:** [Ollama](https://ollama.com/) installed and running with the default embedding model: + +```bash +ollama pull ordis/jina-embeddings-v2-base-code +``` + +**Key results** across 8 languages and real GitHub bug-fix tasks: + +| Metric | Improvement | +| ------------------- | ----------------------- | +| Cost (avg) | -26% | +| Session time (avg) | -28% | +| Output tokens (avg) | -37% | +| Patch quality | Maintained in all tasks | + +See the [Lumen repository](https://github.com/ory/lumen) for benchmarks, configuration, and supported languages. diff --git a/docs/ecosystem/mcp.mdx b/docs/ecosystem/mcp.mdx deleted file mode 100644 index 19fd1be0b..000000000 --- a/docs/ecosystem/mcp.mdx +++ /dev/null @@ -1,105 +0,0 @@ ---- -id: mcp -title: Ory Docs MCP Server -sidebar_label: Docs MCP Server ---- - -The Ory Docs MCP (Model Context Protocol) server gives AI assistants direct access to Ory documentation, enabling more accurate -and context-aware answers to your questions. - -MCP is an open protocol that allows AI tools to query external knowledge sources. Once configured, your AI assistant can search -and retrieve Ory documentation in real time. - -**Server URL:** `https://ory-docs.mcp.kapa.ai` - -## Cursor - -Add the following to your `.cursor/mcp.json` file: - -```json -{ - "mcpServers": { - "ory-docs": { - "type": "http", - "url": "https://ory-docs.mcp.kapa.ai" - } - } -} -``` - -For more information, see the [Cursor MCP documentation](https://docs.cursor.com/context/model-context-protocol). - -## Claude Code - -```shell -claude mcp add --transport http ory-docs https://ory-docs.mcp.kapa.ai -``` - -Then run the `/mcp` command in Claude Code and follow the steps in your browser to authenticate. - -For more information, see the [Claude Code MCP documentation](https://docs.anthropic.com/en/docs/claude-code/mcp). - -## Claude Desktop - -```json -{ - "mcpServers": { - "ory-docs": { - "command": "npx", - "args": ["mcp-remote", "https://ory-docs.mcp.kapa.ai"] - } - } -} -``` - -## VS Code - -**Prerequisites:** VS Code 1.102+ with GitHub Copilot enabled. - -Create an `mcp.json` file in your workspace `.vscode` folder: - -`.vscode/mcp.json` - -```json -{ - "servers": { - "ory-docs": { - "type": "http", - "url": "https://ory-docs.mcp.kapa.ai" - } - } -} -``` - -For more details, see the [VS Code MCP documentation](https://code.visualstudio.com/docs/copilot/customization/mcp-servers). - -## ChatGPT Desktop - -ChatGPT Desktop supports MCP servers in developer mode: - -1. Open ChatGPT Desktop. -1. Go to **Settings > Features**. -1. Enable **Developer mode**. -1. Navigate to **Settings > MCP Servers**. -1. Click **Add Server** and enter: - - **Name:** `ory-docs` - - **URL:** `https://ory-docs.mcp.kapa.ai` - -For more information, see the [ChatGPT Desktop MCP documentation](https://platform.openai.com/docs/guides/developer-mode). - -## Other clients - -MCP is an open protocol supported by many clients. Use the server URL `https://ory-docs.mcp.kapa.ai` and refer to your client's -documentation for setup instructions. - -Most clients accept the standard MCP JSON configuration format: - -```json -{ - "mcpServers": { - "ory-docs": { - "url": "https://ory-docs.mcp.kapa.ai" - } - } -} -``` diff --git a/src/sidebar.ts b/src/sidebar.ts index 73aec49ab..d9177689a 100644 --- a/src/sidebar.ts +++ b/src/sidebar.ts @@ -177,7 +177,7 @@ const quickstart: SidebarItemsConfig = [ "welcome", "intro", "getting-started/local-development", - "ecosystem/mcp", + "ecosystem/ai-tools", { type: "category", label: "Quickstart", @@ -1172,6 +1172,7 @@ const opensource: SidebarItemsConfig = [ "ecosystem/community", "ecosystem/contributing", "open-source/commitment", + "ecosystem/ai-tools", "ecosystem/software-architecture-philosophy", { type: "category", diff --git a/vercel.json b/vercel.json index c4c35c739..5d01649e5 100644 --- a/vercel.json +++ b/vercel.json @@ -5,6 +5,11 @@ "cleanUrls": true, "trailingSlash": false, "redirects": [ + { + "source": "/docs/ecosystem/mcp", + "destination": "/docs/ecosystem/ai-tools", + "permanent": false + }, { "source": "/", "destination": "/docs",