Workflowy MCP服务器

一个为Workflowy提供MCP兼容接口的服务器,允许AI助手以编程方式与您的Workflowy列表进行交互。

  • by danield137
  • TypeScript
  • 本地部署
  • 28 星标
  • 更新于
在 GitHub 查看 danield137/mcp-workflowy

使用说明

Workflowy MCP

一个用于与Workflowy交互的模型上下文协议(MCP)服务器。此服务器为Workflowy提供了一个兼容MCP的接口,使AI助手能够以编程方式与您的Workflowy列表进行交互。

MCP是什么?

模型上下文协议(MCP)是人工智能模型与外部工具和应用程序编程接口(API)交互的一种标准化方式。此服务器实现了MCP,以便人工智能助手(如ChatGPT)能够通过一组定义好的工具读取和操作您的Workflowy列表。

功能

  • Workflowy 集成使用用户名/密码身份验证连接到您的Workflowy帐户
  • MCP 兼容性全面支持模型上下文协议
  • 工具操作在你的Workflowy中搜索、创建、更新节点,并将其标记为完成/未完成

示例用法:

我个人使用Workflowy作为我的项目管理工具。 给予我的代理访问我的笔记和代码库的权限,以下是实用的提示:

  • “在Workflowy中显示我关于项目XYZ的所有笔记”
  • 审查代码库,将所有已完成的备注标记为已完成
  • 根据我在Workflowy上为这个项目设定的里程碑,建议我接下来应该做什么任务

安装

前提条件

  • Node.js v18或更高版本
  • 一个Workflowy账户

快速安装

# Install the package globally
npm install -g mcp-workflowy

# Or use npx to run it directly
npx mcp-workflowy server start

配置

创建一个 .env 在你项目目录中的文件内容如下:

WORKFLOWY_USERNAME=your_username_here
WORKFLOWY_PASSWORD=your_password_here

或者,您可以在运行服务器时将这些凭据作为环境变量提供。

用法

启动服务器

# If installed globally
mcp-workflowy server start

# Using npx
npx mcp-workflowy server start

可用工具

这个MCP服务器提供了以下工具来与您的Workflowy进行交互:

  1. 列出节点 从你的Workflowy中获取节点列表(根节点或指定节点的子节点)
  2. 搜索节点 根据查询文本搜索节点
  3. 创建节点 在你的Workflowy中创建一个新节点
  4. 更新节点 修改现有节点的文本或描述
  5. 切换完成 标记一个节点为已完成或未完成

与AI助手集成

要使用此MCP服务器与AI助手(如ChatGPT)配合:

  1. 按照上述说明启动MCP服务器
  2. 将您的AI助手连接到MCP服务器(请参阅您的AI助手的文档)
  3. AI助手现在将能够读取和操作您的Workflowy列表

一键式

贡献

欢迎贡献!请随时提交拉取请求。

许可证

这个项目遵循MIT许可证 - 详见 许可证 详情文件。