diff --git a/docs/src/ai/agent-panel.md b/docs/src/ai/agent-panel.md index 2b4a8a4692f6539b67b6e3a097aecccb2002ddf8..9fe3ffc4b7883a4c729ca37ac29989a55d9e8a50 100644 --- a/docs/src/ai/agent-panel.md +++ b/docs/src/ai/agent-panel.md @@ -11,7 +11,7 @@ You can do that by: 1. [subscribing to our Pro plan](https://zed.dev/pricing), so you have access to our hosted models 2. [using your own API keys](./llm-providers.md#use-your-own-keys), either from model providers like Anthropic or model gateways like OpenRouter. -3. using an external agent like [Gemini CLI](./external-agents.md#gemini-cli) or [Claude Code](./external-agents.md#claude-code) +3. using an [external agent](./external-agents.md) like [Gemini CLI](./external-agents.md#gemini-cli) or [Claude Code](./external-agents.md#claude-code) ## Overview {#overview} diff --git a/docs/src/ai/external-agents.md b/docs/src/ai/external-agents.md index 054ffb08f7605cd0f690dfbddc9f83e42a1f91a1..59ad764483b74b9b7c1557082d953568b90b802f 100644 --- a/docs/src/ai/external-agents.md +++ b/docs/src/ai/external-agents.md @@ -3,7 +3,7 @@ Zed supports terminal-based agents through the [Agent Client Protocol (ACP)](https://agentclientprotocol.com). Currently, [Gemini CLI](https://github.com/google-gemini/gemini-cli) serves as the reference implementation. -[Claude Code](https://www.anthropic.com/claude-code) and [Codex](https://developers.openai.com/codex) are also included by default, and you can [add custom ACP-compatible agents](#add-custom-agents) as well. +[Claude Code](https://www.anthropic.com/claude-code) and [Codex](https://developers.openai.com/codex) are also included by default, and you can [add custom ACP-compatible agents](#add-more-agents) as well. > Note that Zed's affordance for external agents is strictly UI-based; the billing and legal/terms arrangement is directly between you and the agent provider. > Zed does not charge for use of external agents, and our [zero-data retention agreements/privacy guarantees](./ai-improvement.md) are **_only_** applicable for Zed's hosted models. @@ -182,14 +182,18 @@ And to give it context, you can @-mention files, symbols, or fetch the web. > Note that some first-party agent features don't yet work with Codex: editing past messages, resuming threads from history, and checkpointing. > We hope to add these features in the near future. -## Add Custom Agents {#add-custom-agents} +## Add More Agents {#add-more-agents} -You can run any agent speaking ACP in Zed by changing your settings as follows: +Add more external agents to Zed by installing [Agent Server extensions](../extensions/agent-servers.md). + +See what agents are available by filtering for "Agent Servers" in the extensions page, which you can access via the command palette with `zed: extensions`, or the [Zed website](https://zed.dev/extensions?filter=agent-servers). + +You can also add agents through your `settings.json`, by specifying certain fields under `agent_servers`, like so: ```json [settings] { "agent_servers": { - "Custom Agent": { + "My Custom Agent": { "command": "node", "args": ["~/projects/agent/index.js", "--acp"], "env": {} @@ -198,9 +202,9 @@ You can run any agent speaking ACP in Zed by changing your settings as follows: } ``` -This can also be useful if you're in the middle of developing a new agent that speaks the protocol and you want to debug it. +This can be useful if you're in the middle of developing a new agent that speaks the protocol and you want to debug it. -You can also specify a custom path, arguments, or environment for the builtin integrations by using the `claude` and `gemini` names. +It's also possible to specify a custom path, arguments, or environment for the builtin integrations by using the `claude` and `gemini` names. ## Debugging Agents diff --git a/docs/src/extensions/agent-servers.md b/docs/src/extensions/agent-servers.md index dc9f55b4d77a9e3a6be49fe694718643b30e585f..ce6204e33ee0afd91d705cd90fe4134b9652f8be 100644 --- a/docs/src/extensions/agent-servers.md +++ b/docs/src/extensions/agent-servers.md @@ -1,8 +1,9 @@ # Agent Server Extensions -Agent Servers are programs that provide AI agent implementations through the [Agent Client Protocol (ACP)](https://agentclientprotocol.com). Agent Server Extensions let you package up an Agent Server so that users can install the extension and have your agent easily available to use in Zed. +Agent Servers are programs that provide AI agent implementations through the [Agent Client Protocol (ACP)](https://agentclientprotocol.com). +Agent Server Extensions let you package up an Agent Server so that users can install the extension and have your agent easily available to use in Zed. -You can see the current Agent Server Extensions either by opening the Extensions tab in Zed (execute the `zed: extensions` command) and changing the filter from `All` to `Agent Servers`, or by visiting [https://zed.dev/extensions?filter=agent-servers](https://zed.dev/extensions?filter=agent-servers). +You can see the current Agent Server extensions either by opening the Extensions tab in Zed (execute the `zed: extensions` command) and changing the filter from `All` to `Agent Servers`, or by visiting [the Zed website](https://zed.dev/extensions?filter=agent-servers). ## Defining Agent Server Extensions @@ -147,7 +148,10 @@ For optimal display, follow these guidelines: - Ensure you have a clean SVG code by processing it through [SVGOMG](https://jakearchibald.github.io/svgomg/) - Avoid including icons with gradients as they will often make the SVG more complicated and possibly not render perfectly -Note that we'll automatically convert your icon to monochrome to preserve Zed's design consistency. (You can still use opacity in different paths of your SVG to add visual layering.) +Note that we'll automatically convert your icon to monochrome to preserve Zed's design consistency. +(You can still use opacity in different paths of your SVG to add visual layering.) + +--- This is all you need to distribute an agent server through Zed's extension system!