Skip to content

Commit 4414f13

Browse files
9and3jspaquet
authored andcommitted
[AICW-110] add mcp documentation for mkdocs
1 parent 48c765f commit 4414f13

File tree

4 files changed

+80
-0
lines changed

4 files changed

+80
-0
lines changed

docs/img/mcp/mcp.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/img/mcp/mcp_cgpt_app.png

29.7 KB
Loading

docs/mcp.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
6+
7+
# ![mcp_icon](img/mcp/mcp.svg){: style="height: 32px; vertical-align: middle;" } MCP Cadwork Python API Server
8+
9+
**MCP URL:** `https://cadwork-mcp-pyapi.com/mcp`
10+
11+
## What is MCP?
12+
13+
The **Model Context Protocol (MCP)** is an open standard that enables AI assistants to securely connect to external context. Think of it as a bridge that allows AI models to access real-time, specialized information beyond their training data.
14+
15+
When you connect an AI assistant to an MCP server, it gains the ability to query that server for relevant context, making responses more accurate and up-to-date.
16+
17+
## How MCP helps you learn and use the Cadwork Python API
18+
19+
The Cadwork Python API documentation is available as an MCP server, which transforms how you can learn and work with the API:
20+
21+
- **Contextual Answers**: Ask questions in natural language and get responses that reference the actual API documentation, including function signatures, parameters, and code examples.
22+
- **Code Generation**: Request script snippets for specific tasks. The AI can generate code using the correct Cadwork API functions because it has direct access to the documentation.
23+
- **Discovery**: Explore available modules and functions by simply asking "What functions are available for geometry operations?" or "How do I work with elements?"
24+
- **Troubleshooting**: Describe an error or unexpected behavior, and get help that's grounded in the actual API specifications.
25+
26+
27+
## Setup instructions
28+
29+
To use the Cadwork Python API documentation as an MCP server, you need to configure your AI assistant to connect to it. Here are the most common ai code assistants and how to configure them:
30+
31+
??? note "Claude Desktop"
32+
Add the following to your Claude Desktop configuration file via the UI:
33+
34+
`Settings` > `Connectors` > `Add custom connectors`
35+
36+
[Claude MCP Documentation](https://modelcontextprotocol.io/docs/develop/connect-remote-servers){target=_blank}
37+
38+
??? note "Claude Code (CLI)"
39+
Claude Code supports MCP servers natively. Add the server using:
40+
41+
```bash
42+
claude mcp add cadwork-pyapi https://cadwork-mcp-pyapi.com/mcp
43+
```
44+
45+
[Claude Code MCP Guide](https://docs.anthropic.com/en/docs/claude-code/mcp){target=_blank}
46+
47+
??? note "ChatGPT"
48+
ChatGPT does support MCP servers connector (they are called App) but only on *developer mode*. You need to activate it first and then:
49+
50+
`Settings` > `Apps` > `Create app` (Developer mode: on) > `Create app`
51+
52+
<figure markdown="1">
53+
![Screenshot](img/mcp/mcp_cgpt_app.png){width=300}
54+
</figure>
55+
56+
[OpenAI Plugins Documentation](https://help.openai.com/en/articles/11487775-apps-in-chatgpt#building-your-own-app){target=_blank}
57+
58+
??? note "VS Code (GitHub Copilot)"
59+
Add the following to your VS Code settings file (`.vscode/mcp.json` in your workspace or user settings):
60+
61+
```json
62+
{
63+
"servers": {
64+
"cadwork-pyapi": {
65+
"type": "http",
66+
"url": "https://cadwork-mcp-pyapi.com/mcp"
67+
}
68+
}
69+
}
70+
```
71+
72+
[VS Code MCP Documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers){target=_blank}
73+
74+
## Usage
75+
76+
Once configured, prompt your request to your AI coding assistant and it will automatically query the Cadwork Python API documentation to help you write grounded scripts to our Cadwork Python API.

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ nav:
105105
- videos.md
106106
- Auto Attributes:
107107
- auto_attributes.md
108+
- MCP:
109+
- mcp.md
108110
- About:
109111
- About Guide: about.md
110112
- Release Notes:
@@ -113,6 +115,7 @@ nav:
113115

114116
markdown_extensions:
115117
- admonition
118+
- pymdownx.details
116119
- attr_list
117120
- footnotes
118121
- md_in_html

0 commit comments

Comments
 (0)