Skip to main content
Glama

get_news

Read-onlyIdempotent

Retrieve a single OpenProject news entry by ID, returning the full description by default or a truncated version when text_limit is set.

Instructions

Get a single news entry by id.

The description is returned in full by default (single news entries are not truncated). Pass text_limit to cap it at that many characters; when the text is cut, description_truncated is true and description_length reports the real length.

Input Schema

NameRequiredDescriptionDefault
news_idYes
text_limitNo

Output Schema

NameRequiredDescriptionDefault
idYes
titleYes
authorYes
projectYes
summaryYes
can_deleteYes
can_updateYes
created_atYes
project_idYes
descriptionYes
description_lengthNo
description_truncatedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.4.4
  2. Removedv0.4.0
  3. Changed3 schema fields changedv0.3.7
    • addedInput schema / additionalProperties
      Added value: +false
    • removedOutput schema / properties / url
      Removed value: -{
      -  "title": "Url",
      -  "type": "string"
      -}
    • changedOutput schema / required
      Previous value: -[
      -  "id",
      -  "title",
      -  "summary",
      -  "description",
      -  "project_id",
      -  "project",
      -  "author",
      -  "created_at",
      -  "can_update",
      -  "can_delete",
      -  "url"
      -]New value: +[
      +  "id",
      +  "title",
      +  "summary",
      +  "description",
      +  "project_id",
      +  "project",
      +  "author",
      +  "created_at",
      +  "can_update",
      +  "can_delete"
      +]
  4. First observedv0.2.2

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare this as a safe, idempotent read operation. The description adds useful behavioral context about truncation: full text is returned by default, text_limit caps it, and the description_truncated and description_length fields indicate when and how much it was cut.

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 three short sentences, front-loads the core purpose, and then explains the only non-obvious parameter behavior. No sentence is redundant.

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

Completeness5/5

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

With an output schema present and read-only annotations already covering safety semantics, the description supplies exactly the missing context an agent needs: single-entry retrieval and truncation behavior. Nothing critical for correct invocation is absent.

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

Parameters4/5

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

Schema description coverage is 0%, so the description must compensate. It clearly explains the meaning and effects of text_limit, including truncation behavior, while news_id is self-evident as an integer identifier and reasonably left implicit.

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

Purpose5/5

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

The description states a specific verb and resource: 'Get a single news entry by id.' The word 'single' clearly distinguishes it from list_news, create_news, update_news, and delete_news without needing to name them.

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?

Usage is implied by the tool name and the 'by id' phrasing, but the description does not explicitly say when to use this tool versus list_news or other retrieval routes. It also does not mention prerequisites, error behavior, or alternatives.

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

Deploy Server

Other Tools