使用说明

项目简介

Nash MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在增强大型语言模型(LLM)的能力。它通过提供一系列工具,使得 LLM 客户端能够与外部环境进行交互,扩展了 LLM 的应用场景和功能。

主要功能点

  • 命令执行: 允许 LLM 执行 shell 命令,方便进行系统操作和信息查询。
  • Python 代码执行: 支持 LLM 运行 Python 代码,进行复杂的数据处理和计算。
  • 网页内容访问: 使 LLM 能够获取和分析网页内容,扩展信息获取渠道。
  • 安全密钥管理: 提供安全的 API 密钥存储和访问机制,避免敏感信息泄露。
  • 任务自动化: 支持创建、保存和复用任务流程,提高工作效率。
  • 会话管理: 为每个服务器实例创建独立的会话目录,持久化存储脚本、日志等信息。

安装步骤

  1. 安装 Python 3.11+: 确保您的系统已安装 Python 3.11 或更高版本。
  2. 安装 Poetry: 推荐使用 Poetry 进行依赖管理,请先安装 Poetry:
    pip install poetry
  3. 克隆仓库: 将 nash-mcp 仓库克隆到本地:
    git clone https://github.com/nash-app/nash-mcp.git
  4. 进入仓库目录: 进入克隆下来的仓库目录:
    cd nash-mcp
  5. 安装依赖: 使用 Poetry 安装项目依赖:
    poetry install

服务器配置

MCP 服务器需要 MCP 客户端进行连接和配置。以下是 MCP 客户端(如 Claude Desktop)配置 Nash MCP Server 的 JSON 示例:

{
  "mcpServers": {
    "Nash": { // 服务器名称,可以自定义
      "command": "/path/to/nash-mcp/.venv/bin/mcp", // MCP 服务器启动命令的绝对路径,指向虚拟环境中的 mcp 可执行文件
      "args": [
        "run",
        "/path/to/nash-mcp/src/nash_mcp/server.py" // MCP 服务器入口脚本的绝对路径
      ]
    }
  }
}

配置说明:

  • '"Nash"': 服务器名称,可以根据需要自定义,在客户端中用于标识和选择该服务器。
  • '"command"': 请将 '/path/to/nash-mcp/.venv/bin/mcp' 替换为实际的 'mcp' 可执行文件的绝对路径。 该路径指向 Poetry 创建的虚拟环境中的 'mcp' 启动器。
  • '"args"': 请将 '/path/to/nash-mcp/src/nash_mcp/server.py' 替换为实际的 'server.py' 文件绝对路径。 'run' 参数表示运行模式,后面跟随服务器入口脚本的路径。

环境变量配置:

Nash MCP Server 依赖以下环境变量,请在仓库根目录下创建 '.env' 文件并配置:

NASH_SECRETS_PATH=/path/to/secrets.json  # secrets.json 文件路径,用于存储 API 密钥等敏感信息
NASH_TASKS_PATH=/path/to/tasks.json    # tasks.json 文件路径,用于存储保存的任务
NASH_LOGS_PATH=/path/to/logs/directory   # 日志文件存储目录路径
NASH_SESSIONS_PATH=/path/to/sessions/directory # 会话文件存储目录路径

注意: 请将 '/path/to/secrets.json'、'/path/to/tasks.json'、'/path/to/logs/directory' 和 '/path/to/sessions/directory' 替换为实际的文件或目录路径。这些路径需要您根据实际情况进行设置,确保 MCP 服务器可以正确访问和存储数据。

基本使用方法

  1. 启动 MCP 服务器: 配置完成后,MCP 服务器将在后台运行,监听来自 MCP 客户端的请求。
  2. 配置 MCP 客户端: 在 MCP 客户端(如 Claude Desktop)中配置上述 JSON 信息,客户端将连接到 Nash MCP Server。
  3. 使用工具: 通过 MCP 客户端的界面,您可以调用 Nash MCP Server 提供的各种工具,例如执行命令、运行 Python 脚本、访问网页等,以扩展 LLM 的功能。
  4. 任务管理: 您可以创建、保存和执行可复用的任务,提高自动化工作效率。

详细的工具使用方法和工作流程,请参考仓库的 'README.md' 文件。

信息

分类

AI与计算