项目简介

Veas CLI是一个多功能的命令行界面,旨在为知识管理系统提供AI集成。它通过实现Veas协议并内置Model Context Protocol (MCP) 服务器,允许Claude、GPT等大型语言模型(LLM)客户端与您的知识库、项目管理工具和其他兼容Veas协议的服务进行交互。该工具支持资源托管、工具调用以及Prompt模板渲染,为AI驱动的应用程序提供结构化的上下文服务。

主要功能点

  • AI原生集成: 内置MCP服务器,可与Claude、GPT等主流AI助手无缝协作,为LLM提供丰富上下文。
  • 统一访问: 通过单一命令行界面管理和交互所有兼容Veas协议的知识库和项目管理工具。
  • 可扩展性: 基于开放的Veas协议标准,支持轻松添加新的工具和服务提供商,无需修改核心代码。
  • 文档同步: 支持将本地文档(如Markdown文件)同步到您的在线知识库平台。
  • 安全认证: 提供PAT(个人访问令牌)管理和OAuth 2.0认证流,确保数据访问安全。

安装步骤

  1. 安装Node.js: 确保您的系统已安装Node.js (版本18或更高)。
  2. 全局安装Veas CLI: 打开您的终端或命令行工具,运行以下命令:
    npm install -g veas
    # 或者使用 pnpm
    pnpm add -g veas
  3. 验证安装: 运行 'veas --help' 以确认安装成功并查看可用命令。

MCP服务器配置

Veas CLI的MCP服务器主要通过标准输入输出(Stdio)协议与LLM客户端通信。要将Veas CLI配置为MCP服务器供LLM客户端(如Claude Desktop)使用,您需要提供服务器的启动命令。

Claude Desktop配置示例: 打开您的Claude Desktop配置文件 (macOS: '~/Library/Application Support/Claude/claude_desktop_config.json', Windows: '%APPDATA%\Claude\claude_desktop_config.json'),在 'mcpServers' 部分添加以下JSON配置:

{
  "mcpServers": {
    "veas-knowledge-base": {
      "command": "node",
      "args": [
        "/path/to/your/globally/installed/veas-cli/bin/veas.js",
        "mcp",
        "serve"
      ],
      "env": {
        // 可选:设置您的Veas API基础URL,默认为 https://veas.app
        "VEAS_API_URL": "https://veas.app",
        // 可选:您的个人访问令牌,用于认证MCP服务器对Veas服务的访问。强烈推荐使用。
        // 例如:"VEAS_PAT": "mcp_your_personal_access_token_here"
        // 如果未提供VEAS_PAT,服务器将尝试使用通过"veas auth login"保存的CLI凭据。
        "VEAS_PAT": "your_personal_access_token_if_any",
        // 确保MCP服务器在后台静默运行,不输出额外信息到标准输出,避免干扰JSON-RPC通信
        "MCP_MODE": "true"
      }
    }
  }
}
  • 'server name' (例如 "veas-knowledge-base"): 您为MCP服务器定义的唯一名称,LLM客户端将使用此名称来引用它。
  • 'command': 启动MCP服务器的可执行文件。对于全局安装的Veas CLI,通常是 'node'。
  • 'args': 传递给 'command' 的参数。'"/path/to/your/globally/installed/veas-cli/bin/veas.js"' 应替换为 'veas.js' 脚本的实际路径。'mcp serve' 是启动MCP服务器的核心命令。
  • 'env': 环境变量,用于配置MCP服务器。
    • 'VEAS_API_URL': (可选) Veas API服务器的URL。
    • 'VEAS_PAT': (可选,推荐) 用于MCP服务器认证到Veas后端服务的个人访问令牌。确保此令牌具有必要的权限(例如 'articles:read', 'projects:read')。
    • 'MCP_MODE': 设为 'true' 可以确保服务器在安静模式下运行,避免不必要的输出干扰MCP协议。

基本使用方法

  1. 登录认证: 在使用MCP服务器之前,首先需要登录到Veas平台。
    veas auth login
    按照提示选择认证方式并完成登录。
  2. 启动MCP服务器: 在终端中运行MCP服务器。通常,您会通过LLM客户端(如Claude Desktop)自动启动它,但也可以手动启动进行测试:
    veas mcp serve
  3. 测试MCP连接: 确认MCP服务器已正确启动并可访问Veas服务:
    veas mcp test
    这将尝试连接到服务器并列出可用的工具数量。
  4. 管理知识库: 通过命令行直接操作Veas协议提供的功能,例如:
    veas docs sync --watch # 同步本地文档到知识库并监听文件变化
  5. 与AI助手互动: 配置LLM客户端(如Claude Desktop)后,您就可以在聊天界面中直接调用由Veas CLI MCP服务器提供的工具,例如搜索文章、创建任务等。

信息

分类

AI与计算