@planflow-tools/mcp
v0.2.2
Published
PlanFlow MCP Server for Claude Code - AI-native project management from your terminal
Maintainers
Readme
@planflow/mcp
MCP (Model Context Protocol) server for PlanFlow - AI-native project management from your terminal.
Overview
This package provides a MCP server that integrates PlanFlow with Claude Code, allowing you to manage projects and tasks directly from your AI-powered development workflow.
Quick Start
# 1. Install globally
npm install -g @planflow/mcp
# 2. Add to Claude Desktop config (~/.config/claude/claude_desktop_config.json)
{
"mcpServers": {
"planflow": {
"command": "planflow-mcp"
}
}
}
# 3. Restart Claude Desktop
# 4. In Claude, login with your API token
"Login to PlanFlow with token pf_xxxxx"Requires Node.js >= 20.0.0. See INSTALLATION.md for detailed setup instructions.
Installation
npm install -g @planflow/mcpOr with pnpm:
pnpm add -g @planflow/mcpNeed help? See the complete installation guide for detailed instructions, troubleshooting, and configuration options.
Configuration
Add the MCP server to your Claude Code configuration file (~/.config/claude/claude_desktop_config.json):
{
"mcpServers": {
"planflow": {
"command": "planflow-mcp"
}
}
}Or if installed locally in a project:
{
"mcpServers": {
"planflow": {
"command": "npx",
"args": ["@planflow/mcp"]
}
}
}Authentication
Before using PlanFlow tools, authenticate with your API token:
- Get your API token from planflow.tools/settings/api
- Use the
planflow_logintool in Claude Code with your token
Available Tools
| Tool | Description |
|------|-------------|
| planflow_login | Authenticate with your PlanFlow API token |
| planflow_logout | Clear stored credentials |
| planflow_whoami | Show current authenticated user |
| planflow_projects | List all your projects |
| planflow_create | Create a new project |
| planflow_sync | Sync local PROJECT_PLAN.md to cloud |
| planflow_task_list | List tasks for a project |
| planflow_task_update | Update task status |
| planflow_task_next | Get next recommended task |
| planflow_notifications | View your notifications |
Usage Examples
Login
Use planflow_login with my API token: pf_xxxxxList Projects
Show me my PlanFlow projectsSync Project Plan
Sync my PROJECT_PLAN.md to PlanFlowUpdate Task Status
Mark task T1.5 as done in PlanFlowGet Next Task
What should I work on next?Environment Variables
| Variable | Description | Default |
|----------|-------------|---------|
| PLANFLOW_API_URL | API server URL | https://api.planflow.tools |
| PLANFLOW_DEBUG | Enable debug logging | false |
Configuration Storage
Credentials are stored in ~/.config/planflow/config.json:
{
"apiUrl": "https://api.planflow.tools",
"token": "pf_...",
"userId": "...",
"email": "..."
}Requirements
- Node.js >= 20.0.0
- Claude Code with MCP support
Development
# Install dependencies
pnpm install
# Run in development mode
pnpm dev
# Build for production
pnpm build
# Run tests
pnpm test
# Run tests with coverage
pnpm test:coverageLicense
MIT - see LICENSE for details.
Links
- Installation Guide - Detailed setup instructions
- Full MCP Documentation - Comprehensive docs site guide
- Getting Started - Complete onboarding guide
- PlanFlow Website
- Documentation
- GitHub Repository
- Report Issues
