docs(mcp-server): sync README with canonical MCP docs#338
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 785da52f32
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
packages/mcp-server/README.md
Outdated
|
|
||
| ```bash | ||
| TRANSLOADIT_KEY=MY_AUTH_KEY TRANSLOADIT_SECRET=MY_SECRET_KEY \ | ||
| transloadit-mcp http --host 127.0.0.1 --port 5723 |
There was a problem hiding this comment.
Run HTTP quickstart via npx to avoid missing binary
The new self-hosted HTTP quickstart command invokes transloadit-mcp directly, but this README’s install step uses npm install @transloadit/mcp-server (local install), which does not put that binary on the user’s shell PATH. In that common setup, the quickstart fails with command not found unless users happened to install globally; use npx -y @transloadit/mcp-server http ... (or explicitly document global install) so the documented happy path works.
Useful? React with 👍 / 👎.
What
packages/mcp-server/README.mdto align with website MCP docs## Contributingwith package-relevant setup and validation commandsdocumentationUrltohttps://transloadit.com/docs/sdks/mcp-server/Why
Keep product docs and package docs in sync, with one clear canonical MCP docs owner page.
Validation
corepack yarn checkRelated