Druxt docs

org.druxtjsPublished by druxtjs.orgOfficial publisherv1.0.1Updated Nov 3, 2026

Search and read the Druxt documentation and API reference.

VerifiedStreamable HTTPWeb executableKnowledge & Memory

Overview

Druxt docs's hosted MCP server (druxtjs.org), published by druxtjs.org; no sign-in required; Streamable HTTP; 3 tools.

No AI overview yet: these facts come from the registry entry and the server itself.

Publisher
druxtjs.org
Endpoint
druxtjs.org
Last checked

Installation

In SourceWeft

  1. Open Druxt docs in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.

Use with an agent

Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.

Read https://sourceweft.com/mcp/org.druxtjs%2Fdocs/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.

Read the install guide the agent follows

Other MCP clients

Add this to your client's mcpServers config.

{
  "mcpServers": {
    "druxt-docs": {
      "type": "http",
      "url": "https://druxtjs.org/mcp"
    }
  }
}

README

[druxtjs.org: Nuxt frontend and Drupal backend, built with Druxt]

druxtjs.org

Nuxt frontend and Drupal backend, built with Druxt.

This repository is the source of druxtjs.org, the documentation site for Druxt. It is also a working example of a Druxt site: its pages are Drupal content, rendered by Nuxt.

The site is two applications in one repository. nuxt/ is the frontend. It renders the documentation with Druxt, through DruxtEntity and its wrapper components. drupal/ is the Drupal 11 backend that editors write in.

Get involved

Run the whole site on your machine, frontend and backend together. Pick one of three ways.

WayYou need
Dev containerVS Code with Dev Containers, GitHub Codespaces, or DevPod
misemise, and three PHP extensions
By handPHP 8.3 or later, Composer and Node 16.20.1

Dev container

[Open in DevPod!]

ToolHow
VS CodeClone the repository, open it, then choose Reopen in Container
GitHub CodespacesOn the repository page, open Code and choose Codespaces
DevPodClick the badge, or run devpod up https://github.com/druxt/druxtjs.org

The container has Node 16.20.1, PHP 8.4, Composer and mise. Creating it runs npm install and npm run setup, so Drupal is running when it opens. Then run npm run dev.

mise

.mise.toml pins Node 16.20.1 and PHP 8.4. PHP needs the gd, pdo_sqlite and sodium extensions.

sh
mise installnpm installnpm run setupnpm run dev

By hand

Install PHP 8.3 or later with the gd, pdo_sqlite and sodium extensions, Composer, and Node 16.20.1. Then run:

sh
npm installnpm run setupnpm run dev

What you get

CommandWhat it does
npm installInstalls the root tooling and enables the git hooks
npm run setupInstalls Drupal on a throwaway SQLite database, fetches the pinned druxt.js for the API pages, then starts Drupal
npm run devStarts the Nuxt dev server against that Drupal. The first run installs the frontend's packages
npm run loginPrints a one-time login link for Drupal
ServiceAddress
Drupalhttp://127.0.0.1:8888, or the next free port. npm run info shows which
Nuxthttp://localhost:3000

npm run setup writes Drupal's address to .env, and npm run dev reads it from there. Setup needs network access, for Composer packages and the pinned documentation on GitHub.

Write documentation

  1. Run npm run login, and open the link it prints.
  2. In Drupal, go to Content and edit a page, or add one. The layout paragraphs editor builds a page from sections of text, code and images.
  3. Save, then reload the page on http://localhost:3000.

Preview, on the edit form, shows unsaved changes. docs/backend.md explains its tabs.

An edit made here is local to this machine's database: it previews and tests the site, and is not how page text is published. See Where changes go for what belongs where.

Editors can also sign in on http://localhost:3000 and see a page's latest draft on its own URL. docs/backend.md covers the workflow and the sign-in.

The Modules, API reference and Components pages come from the druxt.js packages. npm run docs:generate builds them locally, in the pinned druxt.js checkout. It installs and builds druxt.js first, so the first run is slow.

Where changes go

ChangeWhere it goes
The content model, the editor or the site's settingsExport them with vendor/bin/drush config:export in drupal/, and commit drupal/config/sync/ in a pull request
The frontendA pull request with the change in nuxt/
The text of a pageDrupal, where editors change it. The database is the source of truth, and page text is not taken as a pull request yet

The site's content is stored in production's database. A local Drupal starts with no pages, and edits in it stay local.

Druxt in the frontend

nuxt/ is a Nuxt 2 app built with Druxt, and it is written to be read as an example of a Druxt site.

WhatHow
PagesEach section page resolves its path with the Druxt router, then renders the Drupal page with <DruxtEntity mode="full">.
Wrappersnuxt/components/druxt/ holds the wrapper components Druxt finds by name. The page is entity/node/DocPageFull.vue, with one component per paragraph type in entity/paragraph/. The rest are fields (field/), layout sections (layout-paragraph/), blocks (block/), block regions (block-region/) and menus (menu/).
Display settingsdruxt-schema reads Drupal's view and form displays when the app builds, so the frontend follows the display settings editors change in Drupal.
Layoutdruxt-layout-paragraphs renders the page's layout sections.
Header, sidebar and footerdruxt-blocks renders the blocks placed in the druxtjs theme's regions in Drupal. The theme and the site's name and logo come from the druxtjs_org consumer's decoupled settings, read at build by nuxt/modules/decoupled-settings.
UInuxt/components/dui/ holds presentational components with no Drupal dependency: code blocks, diagrams, rich text and columns. They will move to the shared Druxt UI library.
Playgroundnuxt/components/global/DruxtExample.vue renders any Druxt component under a runtime of its own for the chosen backend (nuxt/utils/druxt-runtime.js), with what it knows about each component in nuxt/utils/live-examples.js. The same card sits on the module and component reference pages.

To change how something looks, find the wrapper name Druxt looked for (the Vue devtools show it), and add a component at the matching path under nuxt/components/druxt/. Component resolution explains the naming.

Deployment

The site runs on Lagoon as one environment, Drupal beside Nuxt. Nuxt serves pre-rendered pages first, and renders live any page it has not stored or that has aged past its time to live. docs/hosting.md covers what a deployment does.

Commands

CommandWhat it does
npm run setupInstall the backend, then start it
npm run devNuxt dev server against the backend
npm run storybookStorybook on port 3030, against the backend
npm run start / stopStart or stop Drupal
npm run infoWhere Drupal is, and the versions it runs
npm run loginOne-time login link for Drupal
npm run docs:generateBuild the Modules, API reference and Components pages
npm run lintEvery linter except prose
npm run lint:proseVale, after npm run lint:prose:install once
npm testNode tests for the scripts and the frontend's modules

Contributing

See CONTRIBUTING.md for commit messages, checks and what never goes in a file. Open issues and pull requests on druxt/druxtjs.org. docs/backend.md covers page history and previews.

License

MIT

Source: README.md at commit 4bd9380

Tools

3

search_docs

Search the docs

Search the Druxt documentation and API reference. Returns matching pages with their paths.

Parametersqueryrequired

list_docs

List the docs

List Druxt documentation pages, optionally for one section.

Parameterssection

get_doc

Read a docs page

Read one Druxt documentation page as markdown, by its path, such as /how-to/proxy.

Parameterspathrequired

Version history

1
  1. v1.0.1LatestNov 3, 2026

Score

100% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 daysRequired25 pts
  • Auth declaredRequired10 pts
  • Tools listedRequired15 pts
  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts