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許可證。