Skip to main content
Glama
Sign In
FreeCAD Tutor MCP

FreeCAD Tutor MCP

by alex-r-t
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_console_output

Read-onlyIdempotent

Read recent FreeCAD Report view or console log lines (1–1000) to diagnose errors, inspect modeling output, and support step-by-step tutoring.

Instructions

Read recent lines from FreeCAD's Report view / console log (1-1000 lines).

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": "get_console_output"
  }
}

Input Schema

NameRequiredDescriptionDefault
linesNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds the useful operational constraint that the read is bounded to 1-1000 lines and returns only recent output, which is behavior the annotations do not convey.

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?

A single sentence with the resource front-loaded and the range constraint in a parenthetical. Nothing is wasted and there is no 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?

This is a one-parameter read tool with a full annotation set and an output schema, so return values need no explanation. The remaining minor gap is whether output is truncated or how the log is ordered relative to the requested line count, but the definition is sufficient to call it correctly.

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% and the only schema detail is an untyped-looking integer named "lines" with default 100. The description compensates by supplying the valid range (1-1000) and implying that the count refers to the most recent trailing lines, which is the key semantic an agent needs.

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 ("Read") and a specific resource ("FreeCAD's Report view / console log") with a scope qualifier ("recent lines"). It is clear enough to distinguish from siblings like get_recent_activity or get_rpc_status, though it never explicitly contrasts with 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 only implied: the mention of the Report view / console log suggests debugging or error inspection, which is where an agent would reach for it. There is no explicit when-to-use statement, no exclusions, and no named alternative such as explain_freecad_error for interpreting errors.

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