Flow
Menu

Reference

Render a neighbourhood as a diagram

The render-graph tool, and the REST call it is generated from.

RESTGET /api/v1/graph
MCPrender-graph

focus=ready draws the morning picture: the ready set and what each of them unblocks. A task id draws that task's neighbourhood instead.

Parameters

  • focusquery · required · string

    ready for the morning picture, or a task id for that task's neighbourhood.

  • projectquery · optional · array

    Only these proj_… ids (repeat or comma-separate); omit for all of yours. One you are not a member of answers 404.

  • depthquery · optional · integer

    How many edges out from the focus. Defaults to 2.

  • limitquery · optional · integer

    How many tasks to draw at most: for ready, the strongest ready tasks, with what they unblock beside them; for a task, the nearest. Defaults to 40; total says how many the focus matched.

  • link_kindsquery · optional · array

    The edge kinds to draw. Defaults to blocks.

  • formatquery · optional · string

    Defaults to mermaid — the client renders it.

    One of: mermaid, text.

Responses

200The rendered neighbourhood
400The query string does not match the operation's schema
404No such task, or a `project` naming one this caller is not a member of

Generated from the spec this operation is implemented against, so the two names above cannot disagree with the surface a client sees.