Skip to main content
Glama

Ping

ping
Read-only

Verify that the FreeCAD worker is alive and responsive; returns 'pong' on success.

Instructions

Check that the FreeCAD worker is alive. Returns 'pong' on success.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "ping"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspaceNoRun this call in this named workspace

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds the concrete success payload ('pong'), but says nothing about failure behavior, timeouts, or what a dead worker looks like, which is the main thing an agent needs from a health check.

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?

Two short sentences with zero waste; the purpose is front-loaded and the return value follows immediately.

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?

An output schema exists and annotations declare read-only semantics, so the description need not explain return values in depth. For a trivial no-required-param tool this is nearly complete, though a one-clause note on failure/timeout would close the remaining gap.

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?

There is a single optional workspace parameter with 100% schema description coverage, so the schema carries the semantics. The description adds nothing about the workspace parameter, making baseline 3 appropriate.

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: check that the FreeCAD worker is alive, with the success signal ('pong'). It is clearly distinct from mutation-heavy siblings, but it never names near-neighbors like restart_worker or version that an agent might confuse with a health check.

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 liveness-check framing implies when to call it (before/around worker operations), but there is no explicit guidance such as 'call before a long job' or when to prefer restart_worker or version instead. Usage must be inferred.

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