使用说明

项目简介

Mistral Codestral MCP 服务器是一个实现了 Model Context Protocol (MCP) 协议的服务端应用,它利用 Mistral AI 的 Codestral 模型,为支持 MCP 协议的客户端(如代码编辑器插件)提供代码智能服务。该服务器能够处理代码补全、代码错误修复、自动化测试用例生成以及代码片段填充等多种任务,旨在提升开发效率。

主要功能点

  • 代码补全 (Code Completion):基于 Mistral Codestral 模型,提供高质量的代码补全建议。
  • 错误修复 (Bug Fixing):检测代码中的潜在错误,并提供修复建议。
  • 测试生成 (Test Generation):为代码自动生成单元测试用例,辅助保障代码质量。
  • 代码片段填充 (Fill-in-the-Middle, FIM):支持在代码中间位置进行智能补全。
  • 多语言支持:理论上支持 Mistral Codestral 模型支持的多种编程语言。
  • 资源访问:允许通过 'file://code' 资源 URI 访问本地代码文件,方便集成到开发环境。
  • 错误处理:具备完善的错误处理机制,包括 API 错误、速率限制、输入验证等。

安装步骤

  1. 克隆仓库

    git clone https://github.com/bsmi021/mcp-mistral-codestral
    cd mcp-mistral-codestral
  2. 安装依赖 确保已安装 Node.js 和 npm,然后运行:

    npm install
  3. 配置 Mistral API 密钥 复制 '.env.example' 文件并重命名为 '.env',然后编辑 '.env' 文件,填入你的 Mistral API 密钥。

    cp .env.example .env
    vim .env  # 或使用你喜欢的编辑器

    在 '.env' 文件中添加:

    MISTRAL_API_KEY=YOUR_MISTRAL_API_KEY
  4. 构建项目

    npm run build

服务器配置 (MCP 客户端)

对于 MCP 客户端,你需要配置连接到此服务器的命令。以下是一个 JSON 格式的配置示例,通常在 MCP 客户端的设置中添加:

{
  "serverName": "mistral-codestral-mcp",
  "command": "npm",
  "args": ["start"],
  "transport": "stdio",
  "description": "Mistral Codestral MCP Server for code intelligence"
}

配置参数说明:

  • 'serverName': 服务器的名称,可以自定义,用于在客户端中标识该服务器连接。
  • 'command': 启动服务器的命令,这里使用 'npm',因为启动脚本是通过 'npm start' 定义的。
  • 'args': 'command' 命令的参数,这里使用 '["start"]',对应 'npm start' 命令。
  • 'transport': 通信协议,这里使用 'stdio',表示通过标准输入输出流进行通信。
  • 'description': 服务器的描述信息,方便用户理解其用途。

注意: 确保你的 MCP 客户端支持 'stdio' 传输协议。启动服务器前,请先完成安装步骤并配置好 Mistral API 密钥。

基本使用方法

  1. 启动 Mistral Codestral MCP 服务器: 在项目根目录下运行:

    npm start

    服务器成功启动后,会在控制台输出 "Mistral Codestral MCP Server running on stdio"。

  2. 在 MCP 客户端中配置并连接到该服务器。配置信息参考上面的 "服务器配置 (MCP 客户端)" 部分。

  3. 客户端连接成功后,即可在支持的代码编辑器或 IDE 中使用代码补全、错误修复、测试生成等功能。通常,这些功能会通过编辑器的智能提示、代码操作菜单或快捷键触发。

  4. 你可以使用 'code_completion' 工具,并指定不同的 'task' 参数来执行不同的代码智能任务,例如:

    • 'task: "complete"': 代码补全
    • 'task: "fix"': 错误修复
    • 'task: "test"': 测试生成
    • 'task: "fim"': 代码片段填充

    具体的工具参数和使用方式请参考 MCP 客户端的文档,以及本仓库 'README.md' 中 "Available Tools" 部分的描述。

信息

分类

开发者工具