[AICW-110] add mcp documentation for mkdocs #302
+80
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello @jspaquet , @Brunner246 ✋
This PR adds documentation for connecting AI coding assistants to the Cadwork Python API documentation via MCP (Model Context Protocol) that I developed specifically for this API, it is FREE for the user since payed already by Cadwork (we use it for other pipelines).
What is MCP? is an open standard (created by Anthropic) that allows AI assistants like Claude, ChatGPT, and GitHub Copilot to connect to external data sources in real-time. Instead of relying solely on their training data, AI models can query specialized servers to get accurate, up-to-date information.
Why is this useful for Cadwork Python API users
This can help explore the documentation, generate code grounded in the API (no hallucinations), and discover features without manually browsing the docs. It's especially great for new users and for generating scripts without errors and guide them through the API, and I truly believe this can boost the use of this wonderful API for Cadwork.
E.g. this can be true golden tool for new users getting familiar to the API for the first time:
#300 (comment)

What's included?
Let me know what you think!