Workflowy

What is mcp-workflowy?

mcp-workflowy is a Model Context Protocol (MCP) server designed to enable AI models, such as ChatGPT, to interact with Workflowy. It provides an MCP-compatible interface, allowing AI assistants to programmatically read, manipulate, and manage your Workflowy lists.

How to use mcp-workflowy?

To use mcp-workflowy, you need Node.js v18 or higher and a Workflowy account. You can install it globally using npm (npm install -g mcp-workflowy) or run it directly with npx (npx mcp-workflowy server start). Before starting the server, configure your Workflowy username and password in a .env file or as environment variables. Once the server is running, connect your AI assistant to it according to your assistant's documentation. The server exposes several tools that your AI assistant can then utilize to interact with Workflowy.

Key Features of mcp-workflowy

• Workflowy Integration: Seamlessly connects to your Workflowy account using username/password authentication.
• MCP Compatibility: Fully supports the Model Context Protocol, ensuring broad compatibility with various AI assistants.
• Tool Operations: Provides a comprehensive set of tools for interacting with Workflowy nodes, including:
  • list_nodes: Retrieve a list of nodes.
  • search_nodes: Search for nodes by text query.
  • create_node: Create new nodes.
  • update_node: Modify existing node text or descriptions.
  • toggle_complete: Mark nodes as complete or incomplete.

Use Cases of mcp-workflowy

mcp-workflowy is particularly useful for automating tasks and enhancing AI assistant capabilities related to project management and note-taking within Workflowy. Example use cases include:

• Project Management: AI agents can review project milestones, suggest next tasks, and update task statuses in Workflowy.
• Information Retrieval: Quickly retrieve specific notes or information from Workflowy based on AI queries.
• Automated Updates: Automatically mark completed notes or tasks in Workflowy based on external triggers or AI analysis.

FAQ from mcp-workflowy

Q: What is MCP? A: The Model Context Protocol (MCP) is a standardized way for AI models to interact with external tools and APIs. This server implements MCP to allow AI assistants (like ChatGPT) to read and manipulate your Workflowy lists through a set of defined tools.

Q: What are the prerequisites for using mcp-workflowy? A: You need Node.js v18 or higher and a Workflowy account.

Q: How do I configure my Workflowy credentials? A: You can create a .env file with WORKFLOWY_USERNAME and WORKFLOWY_PASSWORD, or provide them as environment variables when running the server.

Workflowy MCP

A Model Context Protocol (MCP) server for interacting with Workflowy. This server provides an MCP-compatible interface to Workflowy, allowing AI assistants to interact with your Workflowy lists programmatically.

What is MCP?

The Model Context Protocol (MCP) is a standardized way for AI models to interact with external tools and APIs. This server implements MCP to allow AI assistants (like ChatGPT) to read and manipulate your Workflowy lists through a set of defined tools.

Features

• Workflowy Integration: Connect to your Workflowy account using username/password authentication
• MCP Compatibility: Full support for the Model Context Protocol
• Tool Operations: Search, create, update, and mark nodes as complete/incomplete in your Workflowy

Example Usage:

Personally, I use workflowy as my project management tool. Giving my agent access to my notes, and my code base, the following are useful prompts:

• "Show my all my notes on project XYZ in workflowy"
• "Review the codebase, mark all completed notes as completed"
• "Given my milestones on workflowy for this project, suggest what my next task should be"

Installation

Prerequisites

• Node.js v18 or higher
• A Workflowy account

Quick Install

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

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

Configuration

Create a .env file in your project directory with the following content:

WORKFLOWY_USERNAME=your_username_here
WORKFLOWY_PASSWORD=your_password_here

Alternatively, you can provide these credentials as environment variables when running the server.

Usage

Starting the Server

# If installed globally
mcp-workflowy server start

# Using npx
npx mcp-workflowy server start

Available Tools

This MCP server provides the following tools to interact with your Workflowy:

1. list_nodes - Get a list of nodes from your Workflowy (root nodes or children of a specified node)
2. search_nodes - Search for nodes by query text
3. create_node - Create a new node in your Workflowy
4. update_node - Modify an existing node's text or description
5. toggle_complete - Mark a node as complete or incomplete

Integrating with AI Assistants

To use this MCP server with AI assistants (like ChatGPT):

1. Start the MCP server as described above
2. Connect your AI assistant to the MCP server (refer to your AI assistant's documentation)
3. The AI assistant will now be able to read and manipulate your Workflowy lists

One-Click

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.