项目简介

这是一个 Model Context Protocol (MCP) 服务器实现,专门用于集成 Workflowy。它允许兼容 MCP 的客户端(如某些 AI 助手或工具)通过标准化的协议访问和操作您的 Workflowy 列表。

主要功能点

  • 连接 Workflowy: 安全地通过账号密码连接到您的 Workflowy 账户。
  • 访问列表内容: 获取 Workflowy 列表的根节点或指定父节点下的子节点。
  • 搜索列表: 根据文本内容搜索 Workflowy 中的节点。
  • 创建节点: 在 Workflowy 中指定的父节点下创建新的列表项。
  • 更新节点: 修改现有节点的名称或描述。
  • 标记完成/未完成: 改变 Workflowy 节点的完成状态。

安装步骤

  1. 确保您已安装 Node.js (版本 18 或更高)。

  2. 打开终端或命令行工具。

  3. 安装 'mcp-workflowy' 包。您可以选择全局安装或使用 npx 临时运行:

    • 全局安装:
      npm install -g mcp-workflowy
    • 使用 npx 运行 (无需安装):
      npx mcp-workflowy server start

服务器配置

MCP 客户端需要配置服务器的启动方式才能连接。对于 Workflowy MCP 服务器,您需要提供 Workflowy 账户的用户名和密码作为环境变量。

以下是一个典型的 MCP 客户端配置示例(请注意,这只是配置格式的说明,具体配置方式取决于您的 MCP 客户端):

{
  "name": "Workflowy MCP", // 服务器名称,用于客户端界面显示
  "command": "npx",       // 启动服务器的命令
  "args": [               // 命令的参数
    "-y",                 // npx 参数,如果包不存在则自动下载
    "mcp-workflowy@latest", // 要运行的包及其版本
    "server",             // 启动服务器的子命令
    "start"               // 启动服务器的动作
  ],
  "env": {                // 启动服务器时需要设置的环境变量
    "WORKFLOWY_USERNAME": "your_workflowy_username_here", // 您的 Workflowy 用户名
    "WORKFLOWY_PASSWORD": "your_workflowy_password_here" // 您的 Workflowy 密码
  }
}

您也可以在运行服务器前,在服务器启动目录创建一个名为 '.env' 的文件,内容如下:

WORKFLOWY_USERNAME=your_workflowy_username_here
WORKFLOWY_PASSWORD=your_workflowy_password_here

基本使用方法

  1. 根据上述说明启动 Workflowy MCP 服务器。
  2. 在您的 MCP 客户端(如兼容的 AI 助手或开发工具)中配置连接到此服务器。
  3. 连接成功后,AI 助手即可发现并使用 Workflowy MCP 服务器提供的工具(如搜索、创建、更新 Workflowy 节点),并能访问 Workflowy 中的相关上下文信息。您可以尝试向 AI 助手提问或发送指令,例如:
    • "在我的 Workflowy 中搜索关于项目 'AI集成' 的所有笔记。"
    • "在我的收件箱列表中创建一个新的待办事项:'联系客户确认需求'。"
    • "将我的 Workflowy 中 ID 为 'xyz123' 的任务标记为已完成。"

信息

分类

生产力应用