Skip to content

mcp.md

Latest commit

 

History

History
116 lines (75 loc) · 3.75 KB

mcp.md

File metadata and controls

116 lines (75 loc) · 3.75 KB
hide
navigation
toc

mcp_icon{: style="height: 32px; vertical-align: middle;" } MCP Cadwork Python API Server

MCP URL: https://pyapi.mcp.cadwork.dev/mcp

What is MCP?

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.

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.

Demo

See how easy it is to use the Cadwork Python API with an MCP-enabled AI assistant:

MCP Demo with Gemini CLI

You can use the Cadwork Python MCP for:

  • Contextual Answers: Ask questions in natural language and get responses that reference the actual API documentation, including function signatures, parameters, and code examples.
  • 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.
  • Discovery: Explore available modules and functions by simply asking "What functions are available for geometry operations?" or "How do I work with elements?"
  • Troubleshooting: Describe an error or unexpected behavior, and get help that's grounded in the actual API specifications.

Setup instructions

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:

??? note "Claude Desktop"

Add the following to your Claude Desktop configuration file via the UI:

`Settings` > `Connectors` > `Add custom connectors`

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

??? note "Claude Code (CLI)"

Claude Code supports MCP servers natively. Add the server using:

```bash
claude mcp add --transport http cadwork-pyapi https://pyapi.mcp.cadwork.dev/mcp
```

[Claude Code MCP Guide](https://docs.anthropic.com/en/docs/claude-code/mcp){target=_blank}

??? note "ChatGPT"

ChatGPT does support MCP servers connector (they are called App) but only on *developer mode*. You need to activate it
first and then:

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

<figure markdown="1">
![Screenshot](img/mcp/mcp_cgpt_app.png){width=300}
</figure>

[OpenAI Plugins Documentation](https://help.openai.com/en/articles/11487775-apps-in-chatgpt#building-your-own-app){target=_blank}

??? note "VS Code (GitHub Copilot)"

Add the following to your VS Code settings file (`.vscode/mcp.json` in your workspace or user settings):

```json
{
  "servers": {
    "cadwork-pyapi": {
      "type": "http",
      "url": "https://pyapi.mcp.cadwork.dev/mcp"
    }
  }
}
```

[VS Code MCP Documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers){target=_blank}

??? note "Gemini CLI"

Gemini CLI supports MCP servers natively through its command-line interface.

**Prerequisites**: Install the Gemini CLI first:

```bash
npm install -g @google/gemini-cli@latest
```

**Add the server**:

```bash
gemini mcp add --transport http cadwork-pyapi https://pyapi.mcp.cadwork.dev/mcp
```

**Verify the connection**:

```bash
gemini mcp list
```

Once added, the Cadwork Python API documentation will be automatically available when you interact with Gemini CLI.

[Gemini MCP Guide](https://geminicli.com/docs/tools/mcp-server){target=_blank}