productplan-mcp-server

Overview Schema Source Related Servers Discussions Admin

get_key_result

Read-only

Retrieve a key result's details and progress using its objective ID and key result ID. Track OKR status with current data.

Instructions

Get key result details.

USE WHEN: "Tell me about this KR", "KR progress" FAILS WHEN: objective_id or key_result_id not found (use list_key_results to get valid KR IDs).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`objective_id`	Yes	Parent objective ID
`key_result_id`	Yes	Key result ID

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	Yes	The ProductPlan payload (object or array) returned by the API, passed through verbatim
`summary`	Yes	Human-readable summary of the result (e.g. "Found 3 roadmaps")

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv6.0.0Sep 25, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "description": "The ProductPlan payload (object or array) returned by the API, passed through verbatim",
+      "type": "object"
+    },
+    "summary": {
+      "description": "Human-readable summary of the result (e.g. \"Found 3 roadmaps\")",
+      "type": "string"
+    }
+  },
+  "required": [
+    "summary",
+    "data"
+  ],
+  "type": "object"
+}

First observedv5.0.0Mar 9, 2026

TDQS

A4/5.0

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, so the read-only nature is covered. The description adds the failure condition (not found) and the alternative, which is useful context beyond the annotations. It doesn't describe response format or edge cases, but for a simple read operation, this is adequate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise: a single sentence plus two labeled lines for USE WHEN and FAILS WHEN. It front-loads the purpose and provides actionable guidance with zero waste.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is a simple read operation with an output schema. The description covers usage, failure modes, and alternative sourcing of IDs. Given the annotations and output schema, nothing critical is missing. It lacks explicit mention of return format, but the output schema likely covers that.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%: both objective_id and key_result_id are described as 'Parent objective ID' and 'Key result ID' respectively. The description adds no additional parameter semantics beyond what the schema already provides, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states 'Get key result details,' which is a specific verb+resource. It clearly indicates retrieving details of a key result, distinguishing it from list_key_results (which lists) and manage_key_result (which mutates). However, it doesn't explicitly name the sibling it is not, though the resource is distinct from get_objective.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit USE WHEN phrases ('Tell me about this KR', 'KR progress') and FAILS WHEN conditions, directing the agent to list_key_results for valid IDs. This fully covers when to use and what to do if it fails, and implicitly excludes alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server