RunWhen Platform MCP

Get Knowledge Base Article

get_knowledge_base_article

Retrieve a specific RunWhen knowledge base article by its UUID and workspace name. Use it to fetch documentation, runbooks, or reference notes for a workspace when you have the article ID.

Instructions

Get a specific Knowledge Base article by ID.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "note_id": "<note_id>",
      "workspace_name": "<workspace_name>"
    },
    "name": "get_knowledge_base_article"
  }
}

Input Schema

Name	Required	Description	Default
`note_id`	Yes	The UUID of the KB article to retrieve.
`workspace_name`	Yes	The workspace to query (e.g. 't-oncall').

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Jul 7, 2026

TDQS

B3.2/5.0

Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden, and it discloses nothing beyond a safe-read implication. It says nothing about required permissions, what happens on an invalid/missing note_id, or whether access is scoped to the workspace. For a zero-annotation tool this is a notable gap.

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

Conciseness4/5

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

A single front-loaded sentence with zero wasted words. It is efficient, though its brevity verges on under-specification for a tool with no annotations.

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

Completeness3/5

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

An output schema exists, so return-shape explanation is not required, and the two required parameters are fully documented in the schema. Still, with no annotations the description omits access-scoping and failure behavior that an agent would benefit from knowing.

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 description coverage is 100%, so the schema already documents note_id as a UUID and workspace_name as the query workspace. The description adds no format, scoping, or default information beyond that, making the baseline 3 correct.

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?

States a specific verb ('Get') and resource ('Knowledge Base article') scoped to a lookup by ID. The 'by ID' qualifier implicitly separates it from list_knowledge_base_articles and search_workspace, though no sibling is named explicitly.

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

Usage Guidelines3/5

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

The 'by ID' phrasing implies usage (call this when you already have an article UUID rather than a search query), which is adequate routing context. However, no PREREQUISITES or explicit alternatives are stated, so the agent must infer when to prefer this over list_knowledge_base_articles.

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

Deploy Server