Skip to content

Commit bc1127f

Browse files
author
Michael Brunner
committed
Revert Usage section
1 parent 3b5448d commit bc1127f

File tree

1 file changed

+29
-15
lines changed

1 file changed

+29
-15
lines changed

docs/mcp.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,41 @@ hide:
1010

1111
## What is MCP?
1212

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.
1416

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.
1619

1720
## How MCP helps you learn and use the Cadwork Python API
1821

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:
2524

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.
2633

2734
## Setup instructions
2835

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:
3038

3139
??? 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:
3341

3442
`Settings` > `Connectors` > `Add custom connectors`
3543

3644
[Claude MCP Documentation](https://modelcontextprotocol.io/docs/develop/connect-remote-servers){target=_blank}
3745

3846
??? note "Claude Code (CLI)"
39-
Claude Code supports MCP servers natively. Add the server using:
47+
Claude Code supports MCP servers natively. Add the server using:
4048

4149
```bash
4250
claude mcp add --transport http cadwork-pyapi https://pyapi.mcp.cadwork.dev/mcp
@@ -45,7 +53,8 @@ To use the Cadwork Python API documentation as an MCP server, you need to config
4553
[Claude Code MCP Guide](https://docs.anthropic.com/en/docs/claude-code/mcp){target=_blank}
4654

4755
??? 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:
56+
ChatGPT does support MCP servers connector (they are called App) but only on *developer mode*. You need to activate it
57+
first and then:
4958

5059
`Settings` > `Apps` > `Create app` (Developer mode: on) > `Create app`
5160

@@ -56,7 +65,7 @@ To use the Cadwork Python API documentation as an MCP server, you need to config
5665
[OpenAI Plugins Documentation](https://help.openai.com/en/articles/11487775-apps-in-chatgpt#building-your-own-app){target=_blank}
5766

5867
??? note "VS Code (GitHub Copilot)"
59-
Add the following to your VS Code settings file (`.vscode/mcp.json` in your workspace or user settings):
68+
Add the following to your VS Code settings file (`.vscode/mcp.json` in your workspace or user settings):
6069

6170
```json
6271
{
@@ -72,8 +81,8 @@ To use the Cadwork Python API documentation as an MCP server, you need to config
7281
[VS Code MCP Documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers){target=_blank}
7382

7483
??? note "Gemini CLI"
75-
Gemini CLI supports MCP servers natively through its command-line interface.
76-
84+
Gemini CLI supports MCP servers natively through its command-line interface.
85+
7786
**Prerequisites**: Install the Gemini CLI first:
7887

7988
```bash
@@ -99,3 +108,8 @@ To use the Cadwork Python API documentation as an MCP server, you need to config
99108
</figure>
100109

101110
[Gemini MCP Guide](https://geminicli.com/docs/tools/mcp-server){target=_blank}
111+
112+
## Usage
113+
114+
Once configured, prompt your request to your AI coding assistant and it will automatically query the Cadwork Python API
115+
documentation to help you write grounded scripts to our Cadwork Python API.

0 commit comments

Comments
 (0)