Skip to main content
Glama
Sign In

Onplana

by io.github.Onplana
OverviewDiscussionsAdmin

generate_status_report

Read-onlyIdempotent

Generate a Markdown status report for one project (current state, task counts, top risks, recommendations). Returns the report inline; does NOT email it (user can copy or ask "email this to ..." for a separate explicit step). Caller must have visibility into the project.

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": {
      "projectId": "<projectId>"
    },
    "name": "generate_status_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
localeNoOptional. The language to write in, as an app language code: en, es, pt-BR, fr, ar, zh-CN, ja, de or it. Anything else, or nothing, is English.
projectIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / locale
      Added value: +{
+  "description": "Optional. The language to write in, as an app language code: en, es, pt-BR, fr, ar, zh-CN, ja, de or it. Anything else, or nothing, is English.",
+  "type": "string"
+}
  2. Added

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), and the description adds genuinely new context: output is returned inline rather than emailed, and the caller must have project visibility. It stops short of covering size limits or failure behavior.

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?

Front-loaded with the action and resource, followed by the content list, then the key behavioral caveat (no email). No redundant restatement of the title or parameters.

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?

With no output schema, the description usefully explains the return shape (inline Markdown report containing state, counts, risks, recommendations). The only gap is projectId's expected form, which is neither in the schema nor the description.

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 50%: locale is fully documented in the schema, while projectId has no description. The description only implicitly scopes projectId to 'one project' and adds the visibility requirement; it gives no format hints. Baseline 3 applies when the schema carries part of the load.

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 and resource ('Generate a Markdown status report for one project') and enumerates the report contents (current state, task counts, top risks, recommendations). It does not explicitly distinguish itself from near-siblings like compose_status_digest, week_status, or summarize_project, so it falls short of a 5.

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 context is implied: it produces a report for one project and explicitly does not email it, deferring email to a separate explicit step. However, there is no guidance on when to choose this over overlapping siblings such as compose_status_digest or week_status, and no stated prerequisites beyond visibility.

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

All Onplana toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources