Skip to content

Commit 7128db8

Browse files
committed
docs(mcp-server): add package README
1 parent 46b415c commit 7128db8

3 files changed

Lines changed: 53 additions & 1 deletion

File tree

.changeset/mcp-server-readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@transloadit/mcp-server": patch
3+
---
4+
5+
Add a package README so npm shows MCP usage details.
6+

packages/mcp-server/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# @transloadit/mcp-server
2+
3+
Transloadit MCP server (Streamable HTTP + stdio).
4+
5+
This package provides a thin MCP wrapper around `@transloadit/node` for creating, validating, and
6+
monitoring Transloadit Assemblies with a delightful, agent-friendly DX.
7+
8+
## Install
9+
10+
```bash
11+
npm install @transloadit/mcp-server
12+
```
13+
14+
## Quick start (HTTP)
15+
16+
```bash
17+
transloadit-mcp http --host 127.0.0.1 --port 5723
18+
```
19+
20+
## Quick start (stdio)
21+
22+
```bash
23+
transloadit-mcp stdio
24+
```
25+
26+
## Environment
27+
28+
- `TRANSLOADIT_KEY` / `TRANSLOADIT_SECRET` (required for API requests, and for accounts enforcing
29+
signature auth)
30+
- `TRANSLOADIT_MCP_TOKEN` (optional for static bearer auth on non-localhost HTTP)
31+
- `TRANSLOADIT_API` (optional, defaults to api2.transloadit.com)
32+
33+
## Tool surface
34+
35+
See the design spec for all tools, inputs, and outputs:
36+
37+
- `docs/mcp-spec.md`
38+
- `docs/mcp-todo.md`
39+
40+
## Notes
41+
42+
- Hosted MCP calls use bearer tokens. If the account enforces signature auth, you must still provide
43+
`TRANSLOADIT_KEY` + `TRANSLOADIT_SECRET`.
44+
- URL inputs default to safe handling; base64 inputs have explicit limits to keep requests small.
45+

packages/mcp-server/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
"directory": "packages/mcp-server"
1515
},
1616
"files": [
17-
"dist"
17+
"dist",
18+
"README.md"
1819
],
1920
"main": "./dist/index.js",
2021
"types": "./dist/index.d.ts",

0 commit comments

Comments
 (0)