关键词

代码助手智能编程工具调用LLM插件扩展

使用说明

项目简介

mini-cursor 是一个开源项目，旨在提供一个轻量级的、可定制的 MCP 服务器实现，灵感来源于 Cursor 编辑器。它允许开发者和用户搭建自己的 MCP 服务器，为 LLM 应用提供文件访问、代码编辑、终端命令执行、网络搜索等工具能力，从而增强 LLM 在代码编程等领域的应用能力。

主要功能点

  • 实现了 MCP 协议，可以作为 LLM 应用的后端，提供工具和上下文服务。
  • 支持本地和远程工具调用，方便扩展 LLM 的功能。
  • 内置多种实用工具，如文件读写、代码编辑、终端命令执行和网络搜索。
  • 提供交互式命令行界面，方便用户配置和使用。
  • 支持多种 LLM 模型，如 OpenAI, Claude, GLM 等。

安装步骤

  1. 环境准备：确保您的系统已安装 Python 3.9 或更高版本。
  2. 克隆仓库：将 mini-cursor 仓库克隆到本地： 
    git clone https://github.com/the-nine-nation/mini-cursor.git
  3. 进入目录：导航到项目根目录： 
    cd mini-cursor
  4. 安装依赖：使用 pip 安装项目依赖： 
    pip install -e .

服务器配置

mini-cursor 的 MCP 服务器配置通过 'mini_cursor/core/mcp_config.json' 文件进行管理。MCP 客户端（例如 VSCode 插件）需要读取此配置文件，以获取 MCP 服务器的连接信息。

以下是一个 'mcp_config.json' 配置示例，用于连接到本地启动的 mini-cursor MCP 服务器：

{
  "mcpServers": {
    "default": {
      "command": "/usr/bin/python3",  // Python 解释器路径，请根据您的 Python 安装路径修改
      "args": ["/your/abs/path/mini_cursor/core/cursor_mcp_all.py"], // cursor_mcp_all.py 脚本的绝对路径，请替换为您的实际路径
      "env": {
        "BOCHAAI_API_KEY": "sk-xxxx" // (可选) BochaAI API Key，用于支持网络搜索工具，如果您需要使用网络搜索功能，请替换为您在 BochaAI 平台申请的 API Key
      }
    }
  }
}

配置项说明:

  • server name: 服务器名称，例如示例中的 "default"，可以自定义。
  • command: 启动 MCP 服务器的命令。通常设置为 Python 解释器的路径 ('/usr/bin/python3' 或 'python3')。
  • args: 传递给 'command' 的参数列表，用于指定 MCP 服务器脚本的路径。在示例中，指向 'cursor_mcp_all.py' 脚本的绝对路径。
  • env: (可选) 环境变量字典。用于设置 MCP 服务器运行时的环境变量。例如，'BOCHAAI_API_KEY' 用于配置网络搜索工具的 API 密钥。

配置操作:

  • 初始化配置: 首次使用，建议运行 'mini-cursor init' 命令，自动生成 'mcp_config.json' 配置文件。
  • 编辑配置: 使用 'mini-cursor mcp-config' 命令，通过交互式界面编辑 'mcp_config.json' 文件，可以添加、修改或删除 MCP 服务器配置。您也可以直接手动编辑 'mini_cursor/core/mcp_config.json' 文件。

注意: 请务必根据您的实际环境，修改 'command' 和 'args' 中的路径，确保 MCP 客户端能够正确连接到 MCP 服务器。

基本使用方法

  1. 启动 MCP 服务器: 在 mini-cursor 项目根目录下，运行以下命令启动 MCP 服务器：

    mini-cursor-server

    服务器成功启动后，将会在终端输出 "Cursor MCP server running with stdio transport" 等信息。

  2. 启动 MCP 客户端: 在 新的终端窗口 中，同样在 mini-cursor 项目根目录下，运行以下命令启动 MCP 客户端，进入聊天模式：

    mini-cursor chat

    客户端启动后，您可以在 "Query:" 提示符后输入自然语言查询或指令，与 AI 助手进行交互。

  3. 聊天交互: 在聊天模式下，您可以进行以下操作：

    • 提问: 输入自然语言问题，例如 "请帮我创建一个 Python 函数，实现快速排序算法"。
    • 代码生成: 请求 AI 助手生成代码，例如 "生成一段 JavaScript 代码，用于实现表单验证"。
    • 工具调用: 当 AI 助手需要访问文件、编辑代码或执行其他操作时，会自动调用配置的工具。
    • 查看帮助: 输入 'help' 命令，查看聊天模式下可用的特殊命令。
    • 退出: 输入 'quit' 命令，退出聊天模式。

常用命令

  • 'mini-cursor init': 初始化生成 'mcp_config.json' 配置文件。
  • 'mini-cursor config': 交互式配置 OpenAI API 参数，并将参数保存到 '.env' 文件。
  • 'mini-cursor mcp-config': 交互式编辑 'mcp_config.json' 配置文件，管理 MCP 服务器配置。
  • 'mini-cursor chat': 启动 MCP 客户端，进入聊天模式。
  • 'mini-cursor-server': 启动 mini-cursor MCP 服务器。

在聊天模式下，您还可以使用以下命令：

  • 'history': 查看工具调用历史记录。
  • 'message history': 查看完整的消息对话历史记录。
  • 'clear history': 清除消息对话历史记录。
  • 'servers': 查看当前可用的 MCP 服务器及其提供的工具列表。
  • 'config': 在聊天模式下快速修改 OpenAI API 参数。
  • 'mcp-config': 在聊天模式下快速编辑 MCP 服务器配置。
  • 'help': 显示聊天模式下的帮助信息。
  • 'quit': 退出聊天模式。

信息

分类

开发者工具

访问项目