You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/mcp.md
+29-15Lines changed: 29 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,33 +10,41 @@ hide:
10
10
11
11
## What is MCP?
12
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.
13
+
The **Model Context Protocol (MCP)** is an open standard that enables AI assistants to securely connect to external
14
+
context. Think of it as a bridge that allows AI models to access real-time, specialized information beyond their
15
+
training data.
14
16
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.
17
+
When you connect an AI assistant to an MCP server, it gains the ability to query that server for relevant context,
18
+
making responses more accurate and up-to-date.
16
19
17
20
## How MCP helps you learn and use the Cadwork Python API
18
21
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.
22
+
The Cadwork Python API documentation is available as an MCP server, which transforms how you can learn and work with the
23
+
API:
25
24
25
+
-**Contextual Answers**: Ask questions in natural language and get responses that reference the actual API
26
+
documentation, including function signatures, parameters, and code examples.
27
+
-**Code Generation**: Request script snippets for specific tasks. The AI can generate code using the correct Cadwork
28
+
API functions because it has direct access to the documentation.
29
+
-**Discovery**: Explore available modules and functions by simply asking "What functions are available for geometry
30
+
operations?" or "How do I work with elements?"
31
+
-**Troubleshooting**: Describe an error or unexpected behavior, and get help that's grounded in the actual API
32
+
specifications.
26
33
27
34
## Setup instructions
28
35
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:
36
+
To use the Cadwork Python API documentation as an MCP server, you need to configure your AI assistant to connect to it.
37
+
Here are the most common ai code assistants and how to configure them:
30
38
31
39
??? note "Claude Desktop"
32
-
Add the following to your Claude Desktop configuration file via the UI:
40
+
Add the following to your Claude Desktop configuration file via the UI:
0 commit comments