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
docs: update README with MCP endpoint configuration
Add client configuration examples for Claude Desktop, Claude Code,
VS Code, and Cursor. Document the /_/mcp endpoint URL pattern and
API key auth requirement. Update settings page link to point to
GitHub docs. Add CHANGELOG entry for 0.7.0 with migration notes.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy file name to clipboardExpand all lines: CHANGELOG.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,21 @@
1
1
# Changelog
2
2
3
+
## 0.7.0
4
+
5
+
### MCP server moved into the Worker
6
+
7
+
The standalone `@oddbit/shrtnr-mcp` npm package has been replaced by a built-in remote MCP endpoint at `/_/mcp`. Every shrtnr deployment now serves an MCP server over Streamable HTTP transport, authenticated with API keys.
8
+
9
+
- Added `/_/mcp` endpoint using Cloudflare's `agents` SDK with `createMcpHandler()`
10
+
- MCP tools call the service layer directly instead of going through HTTP
11
+
- Stateless per-request design: no Durable Objects required
12
+
- Removed the `mcp/` package directory and its npm publish workflow
13
+
- Updated `release-packages.yml` and `detect-releases.sh` to cover SDK only
14
+
15
+
### Migration from `@oddbit/shrtnr-mcp`
16
+
17
+
Replace `npx @oddbit/shrtnr-mcp` with a remote connection to your shrtnr deployment. See the MCP section in `README.md` for client configuration examples.
18
+
3
19
## 0.6.3
4
20
5
21
- Removed all em dashes from source files, page titles, and comments per writing rules
Copy file name to clipboardExpand all lines: README.md
+84-14Lines changed: 84 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ It takes one click to deploy. You get a full admin UI, click analytics, a TypeSc
20
20
-**Multi-language admin UI** with English, Indonesian, and Swedish built in
21
21
-**API key authentication** with scoped Bearer tokens for programmatic access
22
22
-**TypeScript SDK** ([`@oddbit/shrtnr`](https://www.npmjs.com/package/@oddbit/shrtnr)) for Node.js and browser apps
23
-
-**MCP server**([`@oddbit/shrtnr-mcp`](https://www.npmjs.com/package/@oddbit/shrtnr-mcp)) so Claude, Copilot, and other AI assistants can shorten URLs
23
+
-**Built-in MCP server**at `/_/mcp` so Claude, Copilot, and other AI assistants can shorten URLs
24
24
-**SSO via Cloudflare Access** supporting Google, GitHub, OTP, SAML, OIDC, and any IdP
25
25
-**One-click deploy** with automatic database provisioning and migrations
26
26
@@ -79,12 +79,90 @@ Shorten URLs, manage links, and read analytics from any TypeScript or JavaScript
79
79
80
80
### MCP Server (AI Integration)
81
81
82
-
Let Claude, GitHub Copilot, or any MCP-compatible AI assistant create and manage short links.
82
+
Every shrtnr deployment includes a built-in [MCP](https://modelcontextprotocol.io/) endpoint at `/_/mcp`. Claude, GitHub Copilot, Cursor, and any MCP-compatible client can connect to it over Streamable HTTP transport to create and manage short links.
83
+
84
+
The endpoint requires an API key. Create one from the admin UI under **API Keys** with `create,read` scope.
85
+
86
+
#### Available tools
87
+
88
+
| Tool | Description |
89
+
|---|---|
90
+
|`health`| Check server health and version |
91
+
|`list_links`| List all short links with slugs and click counts |
92
+
|`get_link`| Get details for a link by ID |
93
+
|`create_link`| Shorten a URL (supports labels, vanity slugs, expiry) |
94
+
|`update_link`| Update a link's URL, label, or expiry |
95
+
|`disable_link`| Disable a link so it stops redirecting |
96
+
|`add_vanity_slug`| Add a custom slug to an existing link |
97
+
|`get_link_analytics`| Get click stats by country, referrer, device, and browser |
Use the same `mcp-remote` approach as Claude Desktop, or configure via each editor's MCP settings with the endpoint URL `https://your-domain.com/_/mcp` and an `Authorization: Bearer sk_...` header.
0 commit comments