Zum Inhalt
Für Agenten

MCP Reference

roadmap_get

Get Roadmap

Markdown Tools als JSON

Beschreibung

Fetches a single roadmap with full Markdown description, every entry in display order, and each entry's linked projects.

Use this when you need to read or diff a roadmap's contents. Pair with roadmap_save / roadmap_entry_save to write back — descriptions round-trip via Markdown ↔ Tiptap without loss.

Errors with not found or not accessible when the roadmap doesn't exist OR the caller has no access (the message is ambiguous on purpose to prevent ID enumeration).

Zugriff

Zugriffsprofil: gated. Module: projects_tasks. Die Freigabe im Profil ersetzt keine Account-, Workspace- oder Rollenberechtigung.

Parameter

Name Typ Pflicht Beschreibung
account_id string Ja
id string Ja Roadmap prefix ID (rmap_…).

Eingabeschema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "account_id": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "Roadmap prefix ID (rmap_…)."
    }
  },
  "required": [
    "account_id",
    "id"
  ],
  "type": "object"
}

Ausgabeschema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "roadmap": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "rmap_…"
        },
        "title": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "planned",
            "in_progress",
            "done"
          ]
        },
        "archived": {
          "type": "boolean"
        },
        "workspace": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "key": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "key",
            "name"
          ]
        },
        "entry_count": {
          "type": "integer"
        },
        "updated_at": {
          "type": "string",
          "description": "ISO 8601."
        },
        "created_at": {
          "type": "string",
          "description": "ISO 8601."
        },
        "description_markdown": {
          "type": [
            "string",
            "null"
          ]
        },
        "entries": {
          "type": "array",
          "description": "All entries in display order (position asc, id asc).",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "rent_…"
              },
              "title": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "planned",
                  "in_progress",
                  "done",
                  "cancelled"
                ]
              },
              "starts_on": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "ISO date (YYYY-MM-DD) or null."
              },
              "due_on": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "ISO date (YYYY-MM-DD)."
              },
              "position": {
                "type": "integer",
                "description": "Manual ordering within the roadmap."
              },
              "description_markdown": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "owner": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "name"
                ]
              },
              "projects": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "proj_…"
                    },
                    "name": {
                      "type": "string"
                    },
                    "color": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ]
                }
              }
            },
            "required": [
              "id",
              "title",
              "status",
              "position",
              "owner",
              "projects"
            ]
          }
        }
      },
      "required": [
        "id",
        "title",
        "status",
        "archived",
        "workspace",
        "entries"
      ]
    }
  },
  "required": [
    "roadmap"
  ],
  "type": "object"
}
Seiten