Agent documentation index: llms.txt. Markdown versions are available for docs pages.
Zed Industries
Download

Extension Publishing Prerequisites

Before submitting your extension for publishing, make sure it meets the following requirements.

Note that maintainers will raise non-compliance during the publishing process. Should you choose not to follow these requirements, publishing will be delayed or may outright be rejected.

General Requirements

  • Test your extension within Zed manually at the submodule commit you are submitting.
  • Publish functionality that is not already available in the extension registry.
    • If you face issues with an existing extension, first try contributing to the existing extension. See the FAQ for more details on this requirement.
  • Do not misuse the extension API to work around its current limitations.
    • In rare cases, we may accept a reasonable workaround.
    • Acceptance of a workaround is at the maintainers’ discretion.
  • Use an appropriate ID for your extension. The ID must:
    • be unique
    • be kebab-cased
    • not include the words zed or extension
    • be a good indicator for what your extension provides (more on this below)
  • Include only the resources your extension needs to function.
  • License your extension under one of the allowed licenses.
  • Write all user-facing text in English.
  • Do not read or modify anything outside the environment Zed designates for your extension.
    • Use the Zed Rust Extension API to read and modify the environment.
    • Use Rust standard library methods to read and modify the work directory provided to the extension.
    • Ask the user to make any other required changes themselves.

Language Extensions

  • Only provide support for the language your extension targets, as well as any dialects that are directly associated with that language.
  • Define a grammar in your extension’s extension.toml for every language that you provide.
  • You may also provide language servers, debuggers and snippets for that language.
  • Choose an extension ID and name similar or equal to the name of the primary language you intend to add.
  • Do not include any Rust code should your extension not also provide language servers.

Language Server Extensions

  • Should your extension only provide a language server, make sure your extension ID reflects that (e.g., by suffixing it with -language-server or -lsp).
  • Do not bundle a language server with the extension. Download it or check for it in the user’s environment through the Zed Rust Extension API.

Debugger Extensions

  • Should your extension only provide a debugger, make sure your extension ID reflects that (e.g., by suffixing it with -debugger).
  • Do not bundle the debug adapter with the extension. Download it or check for it in the user’s environment through the Zed Rust Extension API.

Theme Extensions

  • Only provide themes and nothing else.
  • Make sure your extension ID indicates it is a theme (e.g., by suffixing it with -theme).

Icon Theme Extensions

  • Only provide an icon theme and nothing else.
  • Make sure your extension ID indicates it is an icon theme (e.g., by suffixing it with -icon-theme or -icons).

Snippet Extensions

  • Should your extension only provide snippets, make sure your extension ID reflects that (e.g., by suffixing it with -snippets).
  • Only scope your snippets to the global scope if appropriate. Scope language-specific snippets to the given languages.

MCP Server Extensions

MCP server extensions will be deprecated in favor of the MCP registry in the future; progress for this is tracked in #59351. Please make sure to also publish your server to the registry to ensure it can be used with future versions of Zed.

  • Only provide one MCP server and nothing else.
  • Make sure your extension ID indicates it is an MCP server (e.g., by prefixing it with mcp-server- or suffixing it with -mcp-server).
  • Do not bundle the MCP server with the extension. Download it or check for it in the user’s environment through the Zed Rust Extension API.

Agent Server and Slash Command Extensions

Agent server and slash command extensions have been deprecated and submissions will no longer be accepted. If you intend on making an agent server available within Zed, publish it to the ACP Registry instead.

Passing everything on this list? Let’s get your extension published!