Skip to content

Commit 976133a

Browse files
sybohyclaude
andcommitted
feat: add Seam Docs MCP server install instructions to API reference
Adds setup and usage documentation for the public Seam Docs MCP server to the existing API reference Installation page (renders at /latest/api/installation). Required public landing page for the Anthropic MCP marketplace submission. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 2eaa23a commit 976133a

2 files changed

Lines changed: 207 additions & 0 deletions

File tree

codegen/source/docs/api-reference/installation.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
1+
---
2+
description: Install the Seam SDKs to call the Seam API and connect the Seam Docs MCP server to Claude.
3+
---
4+
15
# Installation
26

7+
There are two ways to start working with Seam:
8+
9+
- **Seam SDKs** — Install one of the official SDKs to call the Seam API from your application.
10+
- **Seam Docs MCP Server** — Connect Claude or another MCP-compatible client to read the Seam documentation directly.
11+
12+
You can use either or both, depending on your workflow.
13+
14+
## Seam SDKs
15+
316
Install one of the Seam SDKs in the programming language of your choice. Seam supports many programming languages, such as the following:
417

518
* JavaScript / TypeScript ([npm](https://www.npmjs.com/package/seam), [GitHub](https://github.com/seamapi/javascript))
@@ -39,3 +52,94 @@ Install using [nuget](https://www.nuget.org/packages/Seam).
3952
{% endtab %}
4053

4154
{% endtabs %}
55+
56+
## Seam Docs MCP Server
57+
58+
The **Seam Docs MCP Server** is a public, read-only [Model Context Protocol](https://modelcontextprotocol.io/) server that gives Claude and other MCP-compatible clients access to the Seam documentation. Connect it once, then ask Claude questions about the Seam API, capabilities, webhooks, and SDK usage. Claude grounds its answers in the most up-to-date Seam docs.
59+
60+
The server is intended for developers integrating with Seam who want Claude to answer Seam documentation questions accurately. It is read-only: it cannot control devices, manage access codes, create resources, or perform any other write operations against the Seam API.
61+
62+
### Server Details
63+
64+
| Property | Value |
65+
| ---------------- | --------------------------- |
66+
| Server URL | `https://mcp.seam.co/mcp` |
67+
| Transport | Streamable HTTP |
68+
| Authentication | None — the server is public |
69+
70+
{% hint style="info" %}
71+
No API key, account, or sign-up is required to use the Seam Docs MCP server. It only reads and returns Seam's public documentation.
72+
{% endhint %}
73+
74+
### What You Can Ask
75+
76+
Once connected, you can ask Claude questions like the following, and Claude will fetch the answer from the Seam docs:
77+
78+
* "How do I unlock a Schlage Encode lock with the Seam API?"
79+
* "Show me the webhook payload for `lock.locked`."
80+
* "What's the difference between an access code and an access grant?"
81+
* "Which endpoints are available for managing thermostat schedules?"
82+
* "How do I create a Connect Webview from the Python SDK?"
83+
* "List the simulation endpoints for sandbox locks."
84+
85+
### Connect From Claude.ai
86+
87+
1. Sign in to [claude.ai](https://claude.ai).
88+
2. Open **Settings → Connectors**.
89+
3. Click **Add custom connector**.
90+
4. Set the **URL** to `https://mcp.seam.co/mcp`.
91+
5. Set the **Name** to `Seam Docs`.
92+
6. Save. No authentication is required.
93+
94+
The connector is now available to Claude in any new conversation.
95+
96+
### Connect From Claude Desktop
97+
98+
1. Open Claude Desktop and go to **Settings → Connectors**.
99+
2. Click **Add custom connector**.
100+
3. Set the **URL** to `https://mcp.seam.co/mcp`.
101+
4. Set the **Name** to `Seam Docs`.
102+
5. Save and restart Claude Desktop if prompted.
103+
104+
### Connect From Claude Code
105+
106+
Run the following command from your terminal:
107+
108+
```bash
109+
claude mcp add --transport http seam-docs https://mcp.seam.co/mcp
110+
```
111+
112+
Or add the following entry to your Claude Code MCP configuration file:
113+
114+
```json
115+
{
116+
"mcpServers": {
117+
"seam-docs": {
118+
"type": "http",
119+
"url": "https://mcp.seam.co/mcp"
120+
}
121+
}
122+
}
123+
```
124+
125+
### Available Tools
126+
127+
The Seam Docs MCP server exposes three read-only tools:
128+
129+
| Tool | Description |
130+
| ------------------- | ------------------------------------------------------------ |
131+
| `search_docs` | Semantic search across all Seam documentation. |
132+
| `get_doc` | Fetch the full content of a specific Seam documentation page. |
133+
| `list_doc_sections` | Browse the Seam documentation tree structure. |
134+
135+
Claude selects the appropriate tool automatically based on your prompt.
136+
137+
### Troubleshooting
138+
139+
* **403 Forbidden on connection** — The server only accepts requests from approved origins (`mcp.seam.co`, `claude.ai`, `app.claude.ai`, and `localhost`). Requests from other origins are rejected.
140+
* **Empty search results** — If `search_docs` returns nothing, broaden your query. Use Seam API resource names (for example, `access_codes`) rather than SDK-specific method names.
141+
* **Connection refused** — Confirm that your network allows outbound HTTPS to `mcp.seam.co`. Some corporate firewalls block custom MCP endpoints.
142+
143+
### Support
144+
145+
For questions or issues with the Seam Docs MCP server, contact [support@seam.co](mailto:support@seam.co).

docs/api-reference/installation.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
1+
---
2+
description: Install the Seam SDKs to call the Seam API and connect the Seam Docs MCP server to Claude.
3+
---
4+
15
# Installation
26

7+
There are two ways to start working with Seam:
8+
9+
- **Seam SDKs** — Install one of the official SDKs to call the Seam API from your application.
10+
- **Seam Docs MCP Server** — Connect Claude or another MCP-compatible client to read the Seam documentation directly.
11+
12+
You can use either or both, depending on your workflow.
13+
14+
## Seam SDKs
15+
316
Install one of the Seam SDKs in the programming language of your choice. Seam supports many programming languages, such as the following:
417

518
* JavaScript / TypeScript ([npm](https://www.npmjs.com/package/seam), [GitHub](https://github.com/seamapi/javascript))
@@ -40,3 +53,93 @@ Install using [nuget](https://www.nuget.org/packages/Seam).
4053

4154
{% endtabs %}
4255

56+
## Seam Docs MCP Server
57+
58+
The **Seam Docs MCP Server** is a public, read-only [Model Context Protocol](https://modelcontextprotocol.io/) server that gives Claude and other MCP-compatible clients access to the Seam documentation. Connect it once, then ask Claude questions about the Seam API, capabilities, webhooks, and SDK usage. Claude grounds its answers in the most up-to-date Seam docs.
59+
60+
The server is intended for developers integrating with Seam who want Claude to answer Seam documentation questions accurately. It is read-only: it cannot control devices, manage access codes, create resources, or perform any other write operations against the Seam API.
61+
62+
### Server Details
63+
64+
| Property | Value |
65+
| ---------------- | --------------------------- |
66+
| Server URL | `https://mcp.seam.co/mcp` |
67+
| Transport | Streamable HTTP |
68+
| Authentication | None — the server is public |
69+
70+
{% hint style="info" %}
71+
No API key, account, or sign-up is required to use the Seam Docs MCP server. It only reads and returns Seam's public documentation.
72+
{% endhint %}
73+
74+
### What You Can Ask
75+
76+
Once connected, you can ask Claude questions like the following, and Claude will fetch the answer from the Seam docs:
77+
78+
* "How do I unlock a Schlage Encode lock with the Seam API?"
79+
* "Show me the webhook payload for `lock.locked`."
80+
* "What's the difference between an access code and an access grant?"
81+
* "Which endpoints are available for managing thermostat schedules?"
82+
* "How do I create a Connect Webview from the Python SDK?"
83+
* "List the simulation endpoints for sandbox locks."
84+
85+
### Connect From Claude.ai
86+
87+
1. Sign in to [claude.ai](https://claude.ai).
88+
2. Open **Settings → Connectors**.
89+
3. Click **Add custom connector**.
90+
4. Set the **URL** to `https://mcp.seam.co/mcp`.
91+
5. Set the **Name** to `Seam Docs`.
92+
6. Save. No authentication is required.
93+
94+
The connector is now available to Claude in any new conversation.
95+
96+
### Connect From Claude Desktop
97+
98+
1. Open Claude Desktop and go to **Settings → Connectors**.
99+
2. Click **Add custom connector**.
100+
3. Set the **URL** to `https://mcp.seam.co/mcp`.
101+
4. Set the **Name** to `Seam Docs`.
102+
5. Save and restart Claude Desktop if prompted.
103+
104+
### Connect From Claude Code
105+
106+
Run the following command from your terminal:
107+
108+
```bash
109+
claude mcp add --transport http seam-docs https://mcp.seam.co/mcp
110+
```
111+
112+
Or add the following entry to your Claude Code MCP configuration file:
113+
114+
```json
115+
{
116+
"mcpServers": {
117+
"seam-docs": {
118+
"type": "http",
119+
"url": "https://mcp.seam.co/mcp"
120+
}
121+
}
122+
}
123+
```
124+
125+
### Available Tools
126+
127+
The Seam Docs MCP server exposes three read-only tools:
128+
129+
| Tool | Description |
130+
| ------------------- | ------------------------------------------------------------ |
131+
| `search_docs` | Semantic search across all Seam documentation. |
132+
| `get_doc` | Fetch the full content of a specific Seam documentation page. |
133+
| `list_doc_sections` | Browse the Seam documentation tree structure. |
134+
135+
Claude selects the appropriate tool automatically based on your prompt.
136+
137+
### Troubleshooting
138+
139+
* **403 Forbidden on connection** — The server only accepts requests from approved origins (`mcp.seam.co`, `claude.ai`, `app.claude.ai`, and `localhost`). Requests from other origins are rejected.
140+
* **Empty search results** — If `search_docs` returns nothing, broaden your query. Use Seam API resource names (for example, `access_codes`) rather than SDK-specific method names.
141+
* **Connection refused** — Confirm that your network allows outbound HTTPS to `mcp.seam.co`. Some corporate firewalls block custom MCP endpoints.
142+
143+
### Support
144+
145+
For questions or issues with the Seam Docs MCP server, contact [support@seam.co](mailto:support@seam.co).

0 commit comments

Comments
 (0)