Skip to main content
Glama
asmith26

jupytercad-mcp

by asmith26

add_torus

Add a torus shape to JupyterCAD models with configurable radii, revolution angles, color, position, and rotation for precise 3D design.

Instructions

Add a torus to the document.

:param name: The name that will be used for the object in the document. :param radius1: The outer radius of the torus. :param radius2: The inner radius of the torus. :param angle1: The revolution angle of the torus on the X axis (0: no torus, 180: half torus, 360: full torus). :param angle2: The revolution angle of the torus on the Y axis (0: no torus, 180: half torus, 360: full torus). :param angle3: The revolution angle of the torus on the Z axis (0: no torus, 180: half torus, 360: full torus). :param color: The color of the torus in hex format (e.g., "#FF5733") or RGB float list. :param position: The shape 3D position. :param rotation_axis: The 3D axis used for the rotation. :param rotation_angle: The shape rotation angle, in degrees. :return: The document itself.

        Warning: This tool will update the JCAD document at the given jcad_path.
        To understand the current state of the document, you MUST first use the 'get_current_cad_design' tool.
        

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNo
colorNo#808080
angle1No
angle2No
angle3No
radius1No
radius2No
positionNo
jcad_pathYes
rotation_axisNo
rotation_angleNo
Behavior3/5

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

With no annotations provided, the description carries the full burden. It does disclose that the tool updates the document and returns the document itself, and it warns about the required pre-step. However, it does not mention potential side effects (e.g., whether an existing object is overwritten) or error behaviors, and the return description is minimal. This is adequate but not deeply transparent.

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?

The description is well-structured: a one-sentence purpose, a clear list of parameter explanations, a return note, and a warning. The param list is somewhat lengthy but necessary given the lack of schema descriptions. The warning is front-loaded enough to emphasize the prerequisite. No filler or redundancy, so it earns a 4 rather than a 3.

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?

Despite having 11 parameters, no output schema, and no annotations, the description covers most essentials: what the tool does, the key parameter semantics, the return value, and the necessary precondition. Missing details include a thorough definition of jcad_path and coordinate system specifics, but overall the description is complete enough for an agent to use the tool 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?

Although schema description coverage is 0%, the description compensates well by explaining 10 of 11 parameters, including radius meanings, angle ranges with examples, and color format. The only required parameter, jcad_path, is not explicitly described in the parameter list, and 'position' and 'rotation_axis' are somewhat vague. Still, the description adds substantial meaning beyond the schema's bare type definitions.

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 clearly states 'Add a torus to the document' with a specific verb and resource. It distinguishes this tool from sibling tools like add_box, add_sphere, and add_cone by naming the exact shape. The purpose is unambiguous and immediately understandable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear usage context by warning that the tool updates the JCAD document and instructs that one must first use 'get_current_cad_design' to understand the current state. This is a concrete prerequisite. However, it does not explicitly mention alternatives or when not to use this tool, so it stops short of a 5.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/asmith26/jupytercad-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server