Skip to main content

Crate onshape_mcp_resources

Crate onshape_mcp_resources 

Source
Expand description

MCP resource definitions for Onshape integration.

This crate provides MCP resources generated at compile time from markdown documentation in docs/src/mcp-resources/. Each subdirectory with an index.md becomes a resource group, and each entry in the index becomes an MCP resource.

§Adding resources

To add a new resource to an existing group (e.g. insights):

  1. Create docs/src/mcp-resources/insights/new-topic.md
  2. Add an entry to docs/src/mcp-resources/insights/index.md: - [New Topic](new-topic.md) — Description of the new topic

To add a new resource group:

  1. Create docs/src/mcp-resources/new-group/index.md
  2. Add entries following the same format

No Rust code changes are needed in either case.

Structs§

ResourceEntry
A single resource entry, populated at compile time by the build script.

Enums§

ResourceError
Errors that can occur when reading a resource.
ResourceResult
Result of dispatching a resource operation.

Constants§

RESOURCES

Functions§

list_resources
List all available MCP resources.
read_resource
Read a specific resource by URI.