@typeroll/mcp-server weekly downloads statistics

Typeroll CMS MCP server

The @typeroll/mcp-server package connects MCP-compatible AI clients to the Typeroll CMS public API. Manage sites through tools to read and write pages, partials, content types, media, redirects, versions; trigger deploys; mint preview links.

The server is a thin transport adapter — tools call the Typeroll REST API, with a few workflow tools composing consecutive API calls such as config plus deploy. Auth happens at the API layer with a site- or org-scoped key; the MCP just carries the bearer through.

Website starter workspace

Run npx @typeroll/mcp-server@latest init ./my-site to generate a project folder for your own repository. It keeps owner rules in brief/rules.md, search strategy in brief/seo.md, a migration brief, task entry points under workflows/, decisions and QA. MCP 0.45.77 adds the rules/SEO/routines files. Use init ./my-site --update to add them to an existing workspace; edited files are preserved for manual review.

This is separate from the generated publication repository. The CMS owns current content and settings. Hosted MCP does not require a local workspace. Read the workspace guide and guided-start documentation. Kickoff prompts live only in the starter files: workflows/new-site.md and workflows/migration.md. workflows/interview.md guides missing decisions one question at a time and resumes from brief/interview.md. Migrations choose text and design/image preservation independently. Load task recipes on demand instead of copying the complete manual into context.

One Page model

Core 0.2.0 and MCP 0.45.0 use one content entity: Page. Every article, checklist, product, directory entry and ordinary page uses the same API, editor, blocks, history, preview and status. content_type selects a schema, URL pattern and default Page template. Custom values belong in fields; title, slug, path, body, SEO and status are built-in Page properties. Use page_ref/page_ref_list for references and a blank type route pattern for records without detail URLs.

Use create_page, list_pages content_type=... and the Content type/Page template tools. Use the Page ID and the same site version throughout editing, references, previews and builds. Existing installations must migrate before running this release. See the model guide and upgrade procedure.

Two ways to connect

• Remote MCP — enter a URL. Use a client with Streamable HTTP support and OAuth or bearer-header authentication. The Cloud endpoint is https://app.typeroll.com/api/mcp; self-hosted portals use https://<your-portal-host>/api/mcp. On Core 0.2.78+, sign in and approve personal access with any role. No API key copying is needed. Confirm a site and version, use select_site, and carry its site_context on site calls. Revoke access in Account → AI connections. Permissions are checked live; the connection expires after 30 days. Legacy OAuth grants remain scoped as before until reconnecting. Manual bearer keys remain supported.
• Local stdio — launch the npm package. Use a client that can run a local command with environment variables. Instructions below.

See client compatibility and verification status for Claude Desktop, Claude Code, Cursor, VS Code, ChatGPT, Cline and Zed. MCP support alone is not proof of a tested Typeroll integration.

This npm package is the stdio transport. The hosted endpoint ships as part of the Typeroll portal itself — same tool surface, same package under the hood.

Key scopes

• Org-scoped key (created at /app/settings/api-keys) — one credential covers every site in your org and every site shared into your org. Suitable for hosted multi-site connections. Stdio works too if you set TYPEROLL_SITE_ID so the install binds to one site.
• Site-scoped key (created at /app/sites/{siteId}/settings/api-keys) — tighter blast radius for a single-site credential, e.g. one you'd hand to a customer for a self-managed site.

Both look like typeroll_live_…; revoke either from the portal and any client using it stops working immediately. Keys can also be listed and revoked through MCP (list_api_keys, revoke_api_key, list_organization_api_keys, revoke_organization_api_key). New keys and other new credentials are created only in the portal, so a secret is shown once to the person creating it and never lands in an agent conversation or log.

Stdio quick start

1. Create an API key in your Typeroll portal — see the two scope options above. Org-scoped is the right default.

2. Add a local MCP server in your agent client. This example uses the mcpServers schema; adapt it to your client’s documented configuration:

   {
     "mcpServers": {
       "typeroll": {
         "command": "npx",
         "args": ["-y", "@typeroll/mcp-server"],
         "env": {
           "TYPEROLL_API_URL": "https://app.typeroll.com",
           "TYPEROLL_API_KEY": "typeroll_live_REPLACE_WITH_YOUR_KEY"
         }
       }
     }
   }
   

   For a self-hosted portal, point TYPEROLL_API_URL at it (e.g. https://cms.example.com). The stdio server and the typeroll extension CLI require HTTPS, except on loopback hosts.…