Project Knowledge Index

Contract for AI Agents

When a user says "project", the canonical sources of truth are:

1. .project/ — Current state, plans, todos, decisions
2. Root markdown files — README.md, DEVELOPMENT.md, etc.
3. docs/ — Long-form reference documentation

Principles

• Natural language stays natural - Users say "project" not ".project/"
• Agents don't guess - Explicit mappings defined here
• Intent over structure - Language maps to intent, not directory names

### 例: タスク作成
```json
{
    "tool": "create_task",
    "arguments": {
        "title": "Implement OAuth authentication",
        "project": "AUTH",
        "priority": "P0",
        "owner": "cursor",
        "description": "Add OAuth 2.0 support for Google and GitHub",
        "depends_on": ["AUTH-002"],
        "estimate": "2d",
        "tags": ["security", "feature"]
    }
}

例: 次のタスクの取得

{
    "tool": "get_next_task",
    "arguments": {
        "owner": "cursor",
        "limit": 3
    }
}

依存関係がすべて完了したタスクを優先度でソートして返します。

例: プロジェクトの初期化

{
    "tool": "init_project",
    "arguments": {
        "project_name": "My App",
        "project_description": "A web application for task management"
    }
}

.project/ をすべての標準ファイルで作成します：index.md、TODO.md、ROADMAP.md、STATUS.md、DECISIONS.md、および todos/ ディレクトリ。

例: タスクをバックログにインポート

{
    "tool": "import_tasks",
    "arguments": {
        "source": ".project/ROADMAP.md",
        "project": "APP",
        "dry_run": true
    }
}

ロードマップを解析し、タスクを BACKLOG.md に追加します。dry_run: true を使用して事前にプレビューできます。

例: タスクをアクティブな作業に昇格

{
    "tool": "promote_task",
    "arguments": {
        "task_id": "APP-001",
        "owner": "cursor",
        "estimate": "2h"
    }
}

タスクを BACKLOG.md から todos/APP-001.md に移動し、完全な YAML フロントマターを付けます。

例: 完了したタスクをアーカイブ

{
    "tool": "archive_task",
    "arguments": {
        "task_id": "APP-001"
    }
}

完了したタスクを todos/ から archive/ に移動し、アクティブなキューを小さく保ちます。

⚙️ 設定

カスタムドキュメントディレクトリ

{
    "mcpServers": {
        "project": {
            "command": "npx",
            "args": ["-y", "project-mcp"],
            "env": {
                "DOCS_DIR": "/path/to/documentation"
            }
        }
    }
}

カスタム作業ディレクトリ

{
    "mcpServers": {
        "project": {
            "command": "npx",
            "args": ["-y", "project-mcp"],
            "cwd": "/path/to/project/root"
        }
    }
}

🧪 開発

# リポジトリをクローン
git clone https://github.com/pouyanafisi/project-mcp.git
cd project-mcp

# 依存関係をインストール
npm install

# テストを実行
npm test

# サーバーをテスト
node src/index.js