Emacs MCP

🚀 Emacs MCP - Emacs的模型上下文协议

本软件包为Emacs实现了模型上下文协议（MCP），扩展了大语言模型（LLMs）访问Emacs环境和配置信息的能力。Emacs MCP能为工具提供有关已加载软件包、可用函数、键绑定、文档等方面的信息。这使得大语言模型可以用于扩展Emacs配置和编写新的软件包，而无需用户手动指定上下文相关的文件。

🚀 快速开始

本项目主要是为Emacs实现了模型上下文协议，让大语言模型能更好地与Emacs交互，利用Emacs的环境和配置信息来辅助扩展配置和开发新包。

📦 安装指南

常规安装

克隆此仓库，并将以下代码包含在你的用户初始化文件（例如，~/.emacs.d/init.el 或等效文件）中：

(add-to-list 'load-path "/path/to/emacs-mcp")
(require 'emacs-mcp)

使用模型上下文协议检查器测试你的配置：

npx @modelcontextprotocol/inspector emacs --batch --load '<path to your init file>' --eval '(emacs-mcp-run-stdio)'

Doom Emacs配置

Doom Emacs没有初始化文件。要在批量模式下运行之前加载用户配置，你需要创建一个 doomscript 文件，该文件用于启动Doom Emacs环境并加载你的配置文件。 你可以创建一个名为 ~/.config/doom/bin/emacs-mcp 的文件，内容如下：

#!/usr/bin/env doomscript
(defcli! emacs-mcp ()
  (doom-modules-initialize)      ; 初始化模块系统
  (doom-initialize t)            ; 像在交互式会话中一样启动Doom
  (doom-startup)                 ; 加载你的模块和用户配置
  (emacs-mcp-run-stdio))         ; 运行MCP服务器

(run! "emacs-mcp")

这将确保运行MCP服务器的Emacs实例能够访问与你的交互式Doom Emacs实例相同的环境和模块。 然后，你可以使用以下命令测试你的配置：

npx @modelcontextprotocol/inspector ~/.config/emacs/bin/doomscript ~/.config/doom/bin/emacs-mcp

💻 使用示例

基础用法

为你的大语言模型客户端配置MCP服务器，按照大语言模型客户端文档的规定修改 mcp.json 文件，例如 Claude Code 或 Amazon Q Developer CLI。

{
  "mcpServers": {
    "emacs": {
      "command": "emacs",
      "args": [
        "--batch",
        "--load",
        "<path to your init file>",
        "--eval",
        "(emacs-mcp-run-stdio)"
      ]
    }
  }
}

高级用法

如果你使用的是Doom Emacs，可以使用以下配置：

{
  "mcpServers": {
    "emacs": {
      "command": "~/.config/emacs/bin/doomscript",
      "args": ["~/.config/doom/bin/emacs-mcp"]
    }
  }
}

📄 许可证

本项目采用MIT许可证。