Skip to main content
Glama
Sign In

Onplana

by io.github.Onplana
OverviewDiscussionsAdmin

append_log

Append a streaming progress log line to the current agent conversation. Required: conversationId (the AiConversation this agent session belongs to), lineNum (monotonic integer the agent maintains), level (INFO/WARN/ERROR/DEBUG or any string <=8 chars), text (the log line up to 4000 chars). Optional taskId attaches the line to a specific task and triggers a real-time UI broadcast so humans see it land. No undo — log lines are append-only.

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": {
      "conversationId": "<conversationId>",
      "lineNum": "<lineNum>",
      "level": "<level>",
      "text": "<text>"
    },
    "name": "append_log"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYesLog line content, up to 4000 chars.
levelYesINFO / WARN / ERROR / DEBUG (or any string up to 8 chars).
taskIdNoOptional task this line is about.
lineNumYesMonotonic integer per conversation.
conversationIdYesAiConversation id (the agent session).
idempotencyKeyNoOptional idempotency key. Pass a stable unique value (e.g. a UUID) to make this create safe to retry: calling again with the same key within 24h - even from a new session after a reconnect - replays the original result and creates no duplicate. Org-scoped; works across conversations.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false, idempotentHint=false, destructiveHint=false. The description adds genuinely new behavioral facts: append-only with no undo, and that supplying taskId triggers a real-time UI broadcast so humans see the line land. It does not mention the schema's idempotencyKey retry behavior, which is the one remaining 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?

Dense and front-loaded: purpose first, then required params, then the optional broadcast behavior, then the append-only caveat. Sentences are long but each carries information; nothing is filler.

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 and six parameters, the description covers the four required fields, the mutating append-only nature, and the taskId broadcast side effect. Only the optional idempotencyKey is left entirely to the schema, which documents it fully, so this is nearly complete.

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 coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema for taskId: it explains the side effect (real-time UI broadcast) rather than just 'task this line is about.' The rest of the parameter commentary largely restates schema constraints (level <=8 chars, text <=4000 chars, monotonic lineNum).

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 precise verb+resource+scope: 'Append a streaming progress log line to the current agent conversation.' No sibling tool does log streaming, so an agent can identify this immediately without opening the schema.

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 framing ('streaming progress log line to the current agent conversation') and it enumerates required fields, but it never states when to choose this over siblings like create_comment or create_issue, nor any when-not condition. Adequate but leaves routing to inference.

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