Skip to content

docs(mcp-server): sync README with canonical MCP docs#338

Merged
kvz merged 5 commits intomainfrom
docs/mcp-server-readme-sync
Feb 17, 2026
Merged

docs(mcp-server): sync README with canonical MCP docs#338
kvz merged 5 commits intomainfrom
docs/mcp-server-readme-sync

Conversation

@kvz
Copy link
Member

@kvz kvz commented Feb 17, 2026

What

  • rewrite packages/mcp-server/README.md to align with website MCP docs
  • keep self-hosted as default happy path and hosted endpoint as fallback
  • document auth model, tool surface, limits, URL/template behavior, metrics, and docs links
  • add inline ## Contributing with package-relevant setup and validation commands
  • update server card documentationUrl to https://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 check

Related

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".


```bash
TRANSLOADIT_KEY=MY_AUTH_KEY TRANSLOADIT_SECRET=MY_SECRET_KEY \
transloadit-mcp http --host 127.0.0.1 --port 5723

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

@kvz kvz merged commit f0381a8 into main Feb 17, 2026
10 checks passed
@kvz kvz deleted the docs/mcp-server-readme-sync branch February 17, 2026 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant