Skip to main content

MCP server for reading OmniPlan (.oplx) and Microsoft Project (.mpp) schedule files

Project description

macOS Python License Release

OmniPlan MCP Server

A Model Context Protocol (MCP) server that lets Claude read and analyze project schedule files — OmniPlan (.oplx) and Microsoft Project (.mpp) formats.

Ask Claude questions like:

  • "What's the current project schedule?"
  • "List all milestones and their dates"
  • "Show me tasks related to the robotic arm"
  • "What's the overall progress percentage?"

Features

Feature Description
📂 Read .mpp Parse Microsoft Project files via OmniPlan bridge
📂 Read .oplx Direct XML parsing (no OmniPlan needed)
🏛️ Full hierarchy Groups, tasks, milestones with dates and progress
🔍 Search Find tasks by keyword across the entire schedule
👤 Resources List all human resources and assignments
📊 Summary Phase overview, progress statistics, timeline
🔒 Safe concurrency Direct AppleScript reading avoids temp-file conflicts when multiple sessions run

Prerequisites

Requirement Notes
macOS Required (for AppleScript/OmniPlan bridge)
Python 3.10+ For running the MCP server
OmniPlan Only needed for .mpp files; .oplx works without it

Install OmniPlan (optional — only for .mpp files)

brew install --cask omniplan

First run: macOS may prompt for Accessibility/Automation permissions when OmniPlan is called via AppleScript. Grant them in System Settings → Privacy & Security → Automation.

Quick Start

1. Install

# Option A: One-line installer (recommended)
curl -fsSL https://raw.githubusercontent.com/cygnusyang/omniplan-mcp/main/install.sh | bash

# Option B: Manual clone
git clone https://github.com/cygnusyang/omniplan-mcp.git
cd omniplan-mcp
pip install -e .

2. Configure Claude Code

Add to your ~/.claude/settings.json:

uv run (recommended)
{
  "mcpServers": {
    "omniplan": {
      "command": "uv",
      "args": [
        "run",
        "--directory", "/Users/yourusername/.local/share/omniplan-mcp",
        "omniplan-mcp"
      ],
      "env": {}
    }
  }
}
pip install (after PyPI publish)
{
  "mcpServers": {
    "omniplan": {
      "command": "uvx",
      "args": ["omniplan-mcp"],
      "env": {}
    }
  }
}
Direct Python
{
  "mcpServers": {
    "omniplan": {
      "command": "/path/to/python3",
      "args": ["-m", "omniplan_mcp"],
      "env": {
        "PYTHONPATH": "/path/to/omniplan-mcp/src"
      }
    }
  }
}

3. Restart Claude Code

The MCP server will start automatically. You can now ask Claude about your project files!

Usage Examples

Read a project schedule

你:帮我读取 PLB1011 项目计划,看看有哪些阶段
Claude:调用 read_schedule → 显示完整任务树

List milestones

你:列出所有里程碑节点
Claude:调用 list_milestones → 显示所有 ◇ 里程碑

Search for tasks

你:搜索所有关于"机械臂"的任务
Claude:调用 search_tasks → 显示匹配的任务列表

Project summary

你:这个项目的整体进度怎么样?
Claude:调用 schedule_summary → 显示阶段概览和进度统计

Tools Reference

Tool Description Parameters
read_schedule Full task hierarchy with dates and progress filepath (required), format: tree/flat/json
list_milestones All milestone tasks filepath
list_resources All human resources filepath
search_tasks Search tasks by keyword filepath, keyword
schedule_summary Phase overview and progress stats filepath

How It Works

.mpp file ──→ OmniPlan (AppleScript direct read) ──→ pipe-delimited records ──→ Claude
                          ↑
.oplx file ───────────────┴─── direct XML parsing ──────┘

For .oplx files

Direct XML parsing — fast, no external dependencies.

For .mpp files

  1. MCP server opens the .mpp file in OmniPlan via the macOS open command
  2. Reads all project data (tasks, resources, dates, progress) directly from OmniPlan's in-memory object model via AppleScript
  3. Parses the pipe-delimited output into structured records
  4. Closes the document

No temporary files are created — data is read directly from OmniPlan's in-memory model.

Project Structure

omniplan-mcp/
├── install.sh                  # One-click installer
├── pyproject.toml              # Package metadata (PyPI-ready)
├── README.md                   # This file
├── LICENSE                     # MIT license
├── .gitignore
├── src/
│   └── omniplan_mcp/
│       ├── __init__.py         # Package version
│       ├── __main__.py         # CLI entry point
│       ├── server.py           # MCP server (tools & handlers)
│       └── parser.py           # .mpp (AppleScript) / .oplx (XML) parsing
└── tests/
    └── test_parser.py          # Unit tests

Development

# Clone
git clone https://github.com/cygnusyang/omniplan-mcp.git
cd omniplan-mcp

# Install in editable mode
pip install -e .

# Run tests
python -m pytest tests/

# Run the server directly (stdio)
python -m omniplan_mcp

Publishing to PyPI

Published automatically via GitHub Actions (Trusted Publisher) when a tag is pushed:

git tag v0.1.0
git push origin v0.1.0

Manual build (for testing):

pip install build
python -m build

Requirements

  • Python 3.10+
  • macOS (for OmniPlan AppleScript bridge)
  • OmniPlan (only for .mpp files; optional for .oplx)

Limitations

  • .mpp parsing requires OmniPlan to be installed
  • Only supports macOS (AppleScript dependency)
  • Does not modify .mpp files — read-only

License

MIT License — see LICENSE for details.

Related

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omniplan_mcp-0.2.2.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

omniplan_mcp-0.2.2-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file omniplan_mcp-0.2.2.tar.gz.

File metadata

  • Download URL: omniplan_mcp-0.2.2.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for omniplan_mcp-0.2.2.tar.gz
Algorithm Hash digest
SHA256 fb15d48c3bc1b0f1cd269dabc7d0b5b754a664c4696c3208df9e8a1905661979
MD5 1abfbefa8988b8f730a01450bd1b4251
BLAKE2b-256 a32ef633c5ed018fb646ceb45a5788379835371ae21e819dd5f56d076fd27207

See more details on using hashes here.

Provenance

The following attestation bundles were made for omniplan_mcp-0.2.2.tar.gz:

Publisher: publish.yml on cygnusyang/omniplan-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file omniplan_mcp-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: omniplan_mcp-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for omniplan_mcp-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 459a145246f5772b4b705911438a36b18d61665c622a9ee7e9f715099b731f5c
MD5 a9bf9db0b57a4e4e18604c275e8bbc3c
BLAKE2b-256 1c9dae6279638270932533119a714ff9b7708599ee233071d02531ba8d9128e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for omniplan_mcp-0.2.2-py3-none-any.whl:

Publisher: publish.yml on cygnusyang/omniplan-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page