Folderr MCP 服务器使用说明

项目简介

Folderr MCP 服务器是一个基于 Model Context Protocol (MCP) 的应用后端，它充当 LLM 客户端与 Folderr API 之间的桥梁。通过此服务器，LLM 可以安全、标准地访问 Folderr 平台的各项功能，例如管理 AI 助手和执行预定义的工作流。

主要功能点

• 身份验证：支持使用邮箱/密码登录或通过 API Token 进行身份验证，确保安全访问 Folderr API。
• 助手管理：允许 LLM 列出可用的 AI 助手，并向指定的助手提问，获取助手响应。
• 工作流管理：支持列出可用的工作流，获取工作流所需的输入参数，并使用提供的输入参数执行工作流。
• 配置管理：服务器配置（如 Folderr API 的 Base URL、身份验证 Token）存储在 'config.json' 文件中，方便管理和持久化。
• 错误处理：提供详细的错误消息，帮助用户诊断和解决常见问题，如身份验证失败、请求无效、API 错误等。

安装步骤

1. 环境准备：确保您的环境中已安装 Node.js 和 npm。
2. MCP 客户端配置：在您的 MCP 客户端设置中，添加 Folderr MCP 服务器的配置信息。

服务器配置

以下 JSON 代码展示了如何在 MCP 客户端中配置 Folderr MCP 服务器。您需要将这段配置添加到您的 MCP 客户端的服务器列表中。

{
  "folderr": {
    "command": "npx",
    "args": ["-y", "@folderr/folderr-mcp-server"]
  }
}

配置参数说明：

• 'folderr': 服务器名称，您可以自定义，用于在 MCP 客户端中标识此服务器。
• 'command': 启动服务器的命令。 'npx' 是 npm 包执行器，这里用于执行 '@folderr/folderr-mcp-server' 包，'-y' 参数用于自动确认安装包。
• 'args': 传递给命令的参数， '["-y", "@folderr/folderr-mcp-server"]' 指定了要执行的 npm 包名称。

注意：

• 上述配置假设您的 MCP 客户端能够执行 'npx' 命令，并且可以访问 npm 仓库以安装 '@folderr/folderr-mcp-server' 包。
• 首次运行时，'npx' 会自动下载并安装 '@folderr/folderr-mcp-server' 包。

基本使用方法

1. 启动 MCP 客户端：配置完成后，启动您的 MCP 客户端。客户端将根据配置自动启动 Folderr MCP 服务器。
2. 身份验证：
   • API Token 认证：调用 'set_api_token' 工具，并提供从 Folderr 开发者平台获取的 API Token。

   {
     "name": "set_api_token",
     "arguments": {
       "token": "YOUR_API_TOKEN"
     }
   }
   

   • 邮箱密码登录：调用 'login' 工具，并提供您的 Folderr 账户邮箱和密码。

   {
     "name": "login",
     "arguments": {
       "email": "YOUR_EMAIL",
       "password": "YOUR_PASSWORD"
     }
   }
   

   推荐使用 API Token 认证，特别是对于自动化或长时间运行的 LLM 应用。
3. 使用工具：身份验证成功后，您可以调用其他工具来管理助手和工作流。例如：
   • 列出助手：

   {
     "name": "list_assistants",
     "arguments": {}
   }
   

   • 向助手提问：

   {
     "name": "ask_assistant",
     "arguments": {
       "assistant_id": "ASSISTANT_ID",
       "question": "Your question for the assistant"
     }
   }
   

   • 列出工作流：

   {
     "name": "list_workflows",
     "arguments": {}
   }
   

   • 执行工作流：

   {
     "name": "execute_workflow",
     "arguments": {
       "workflow_id": "WORKFLOW_ID",
       "inputs": {
         "input1": "value1",
         "input2": "value2"
         // ... 工作流所需的其他输入
       }
     }
   }
   

   请参考仓库的 'README.md' 文件和代码注释，了解更多工具的详细用法和参数说明。