Skip to main content
Glama
andrewbartels1

SolidworksMCP-python

get_file_properties

Retrieve file name, size, type, material, units, author, and description from the active SolidWorks document for organization and version control.

Instructions

Get properties of the current SolidWorks file.

Retrieves comprehensive metadata and properties of the currently active SolidWorks document. Provides essential file information for document management, version control, and project organization.

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

Example: ```python result = await get_file_properties()

                if result["status"] == "success":
                    props = result["properties"]

                    # Basic file info
                    file_info = props["file_info"]
                    print(f"File: {file_info['file_name']}")
                    print(f"Size: {file_info['file_size']}")
                    print(f"Type: {file_info['file_type']}")

                    # Technical properties
                    tech = props["technical_properties"]
                    print(f"Material: {tech['material']}")
                    print(f"Units: {tech['units']}")

                    # Document info
                    doc = props["document_info"]
                    print(f"Author: {doc['author']}")
                    print(f"Description: {doc['description']}")
                ```

            Note:
                - Requires an active SolidWorks document
                - Properties may vary based on document type
                - Some properties may be empty if not set
                - Technical properties depend on document configuration

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 provided. The description implies a read-only operation ('Get properties') but does not explicitly state it is non-destructive. It mentions document requirement and property variation but lacks a clear side-effect statement.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is fairly long with a large Python example. The first sentence is concise, but the repetition of 'Retrieves comprehensive metadata' adds some redundancy. The structure is good with a clear example.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-parameter tool, the description covers purpose, requirements, caveats, and provides a comprehensive example of expected output. It is complete given the tool's simplicity.

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?

No parameters exist, so schema coverage is 100%. The description adds value by including a detailed example of the output structure, which helps understand the return format beyond the schema.

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 the tool's purpose: 'Get properties of the current SolidWorks file.' It elaborates with 'Retrieves comprehensive metadata and properties...' and distinguishes from siblings by focusing on file properties rather than geometry or features.

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 includes a 'Note' section with requirements ('Requires an active SolidWorks document') and caveats ('Properties may vary based on document type'). It provides clear context but does not explicitly mention when to use this tool versus alternatives.

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