https://github.com/danield137/mcp-workflowy
An MCP server for workflowy
https://github.com/danield137/mcp-workflowy
Last synced: 3 months ago
JSON representation
An MCP server for workflowy
- Host: GitHub
- URL: https://github.com/danield137/mcp-workflowy
- Owner: danield137
- License: mit
- Created: 2025-05-03T03:54:08.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-05-07T18:44:53.000Z (7 months ago)
- Last Synced: 2025-08-09T10:43:40.020Z (3 months ago)
- Language: TypeScript
- Size: 83 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-servers - **Workflowy** - A server that interacts with workflowy. `http` `git` `github` (📦 Other)
README
[](https://insiders.vscode.dev/redirect/mcp/install?name=Workflowy%20MCP&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22mcp-workflowy%40latest%22%2C%22server%22%2C%22start%22%5D%2C%20%22env%22%3A%20%7B%22WORKFLOWY_USERNAME%22%3A%22%22%2C%20%22WORKFLOWY_PASSWORD%22%3A%20%22%22%7D%7D)
# 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
```bash
# 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
```bash
# 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
[](https://insiders.vscode.dev/redirect/mcp/install?name=Workflowy%20MCP&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22mcp-workflowy%40latest%22%2C%22server%22%2C%22start%22%5D%2C%20%22env%22%3A%20%7B%22WORKFLOWY_USERNAME%22%3A%22%22%2C%20%22WORKFLOWY_PASSWORD%22%3A%20%22%22%7D%7D)
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.