Skip to main content
Glama
andrewbartels1

SolidworksMCP-python

sketch_tutorial_simple_hole

Create a 5mm circular hole sketch on the Top plane. Demonstrates the fundamental sketch-to-feature workflow for through-holes or counterbores.

Instructions

Tutorial: Create a simple circular hole sketch.

Demonstrates complete workflow for creating a basic hole sketch that can be used for through-holes, counterbores, or other circular features. This tutorial shows the fundamental sketch-to-feature process.

Returns: dict[str, Any]: A dictionary containing the resulting values.

Example: ```python # Learn basic sketching workflow result = await sketch_tutorial_simple_hole()

                if result["status"] == "success":
                    print("Tutorial completed successfully!")
                    print("Steps performed:")
                    for step in result["steps"]:
                        print(f"  - {step}")
                    print(f"Next: {result['next_steps']}")
                ```

            Workflow:
                1. Creates sketch on Top plane
                2. Adds 2.5mm radius circle at origin (5mm diameter hole)
                3. Exits sketch editing mode
                4. Returns sketch ready for extrusion or cutting operations

            Note:
                - Demonstrates complete sketch creation workflow
                - Creates standard 5mm diameter hole geometry
                - Result is ready for negative extrusion to create hole
                - Perfect starting point for learning SolidWorks automation

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

No annotations are provided, so the description bears full responsibility. It outlines the workflow steps (create sketch, add circle, exit sketch) and return values, but does not explicitly state side effects (e.g., whether it modifies an existing part or creates a new one). The 'Note' section adds some context but lacks safety or permission details.

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 structured with sections (Returns, Example, Workflow, Note) and front-loaded with a clear purpose. It is somewhat verbose but every sentence contributes information; a minor trim could improve conciseness.

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?

Given no parameters and an output schema (indicated by context), the description explains the return dict and workflow steps. It covers the tutorial's purpose and outcome, though it could mention prerequisites (e.g., having a part open). Overall, it is sufficient for a tutorial tool.

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?

There are no parameters, so the baseline is 4. The description adds value by explaining the tool's behavior and workflow, which compensates for the lack of param details.

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 identifies the tool as a tutorial for creating a simple circular hole sketch, using specific verbs like 'Create' and 'Demonstrates'. It distinguishes itself from sibling tools like 'tutorial_simple_hole' by focusing on the sketch workflow, not the full hole feature.

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 explains that the tool is for learning the fundamental sketch-to-feature process and is a 'perfect starting point for learning SolidWorks automation'. It implies usage for educational purposes and does not explicitly state when not to use, but the context is clear.

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/andrewbartels1/SolidworksMCP-python'

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