Planyway: Roadmap, Calendar, Time Tracker for Trello, Jira, GitHub

Get model overview

[Native MCP clients only — ChatGPT/OpenAI api_tool MUST use `search`+`fetch` instead.] Returns the model overview: general rules, scopes, namespace, version, list of common types, and field count.

Get common types

[Native MCP clients only — ChatGPT/OpenAI api_tool MUST use `search`+`fetch` instead.] Returns the common types of the model (PlannedTimeMode, EpicMilestoneColorName, BaseWorkloadScheme, CustomWorkloadScheme).

Get reading algorithm

[Native MCP clients only — ChatGPT/OpenAI api_tool MUST use `search`+`fetch` instead.] Returns the recommended order for reading Planyway data plus the list of assumptions.

Get TypeScript model

[Native MCP clients only — ChatGPT/OpenAI api_tool MUST use `search`+`fetch` instead.] Returns the full original TypeScript model block as a single fragment — convenient to feed into an LLM.

List Fields

[Native MCP clients only — ChatGPT/OpenAI api_tool MUST use `search`+`fetch` instead.] Lists Planyway field definitions stored in Jira (storageName, scope, encoding, typeName). Schema only — does not query live Jira data. Optional scope filter: app | space | workItem.

Get Field

[Native MCP clients only — ChatGPT/OpenAI api_tool MUST use `fetch("planyway-jira://fields/<storageName>")` instead, which is stable across session/link rotation.] Returns the static schema definition of a single Planyway field by storageName. Schema only — does NOT read live Jira issue data. Supports template names (e.g. planywayVacationSettings-0 matches planywayVacationSettings-{n}).

Get Common Type

[Native MCP clients only — ChatGPT/OpenAI api_tool MUST use `fetch("planyway-jira://types/<name>")` instead.] Returns the definition of a single common Planyway TypeScript type by name. Schema only.

Decode Field

Decodes the raw value of a Planyway field by its storageName. Resolves the encoding from the catalog: json | deflate+base64 | json-outer+deflate+base64-inner. For the compound encoding (planywayDescription), returns the decoded inner IssueAdditionalDataInternal object. Input value is ALWAYS a string: if app-storage returns a parsed object, JSON.stringify it before calling.

Encode Field

Encodes a value for writing into a Planyway field according to the encoding in the catalog. If value is a string that parses as a JSON object/array, it is parsed automatically before encoding, so clients that pass payloads as stringified JSON still get an object-shaped round-trip. WARNING: the model is read-oriented — use encode only for debugging or reverse-engineering; a separate write contract is required for production writes.

Decompress

Low-level inflation of a Base64-deflate string into JSON (pako.inflate + JSON.parse).

Compress

Low-level compression of a value into a Base64-deflate string (JSON.stringify + pako.deflate level=3 + Base64).

Search

Searches the Planyway data model index (fields, common types, overview, reading algorithm, TypeScript model). Returns up to 20 documents with id/title/url/text. Use the returned id with `fetch` to get full content. Pass an empty query to list all available documents.

Fetch

Fetches a single Planyway data-model document by id (the id returned by `search`). Returns {id, title, url, text, metadata}. text is JSON for fields/types/schema/overview, plain TypeScript for the model.ts document.

Get full schema

[Native MCP clients only — ChatGPT/OpenAI api_tool MUST use `fetch("planyway-jira://schema")` instead.] Returns the entire Planyway Jira data model as JSON.