pulumi-package-docs 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Piers Karsenbarg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,60 @@
+# pulumi-package-docs
+
+A local documentation viewer for the parameterized/local Pulumi providers used by a Pulumi project (e.g. providers added with `pulumi package add`). Run it from inside a Pulumi project and it lists the packages declared in `Pulumi.yaml`'s `packages` section, fetches each one's schema via the `pulumi` CLI, and renders its resources and functions.
+
+## Usage
+
+```bash
+npx pulumi-package-docs
+```
+
+This serves docs for the Pulumi project in your current directory. Options:
+
+```bash
+pulumi-package-docs [options]
+
+  -d, --dir <path>   Pulumi project directory to inspect (default: current directory)
+  -p, --port <port>  Port to serve on (default: 3000)
+  --host             Expose the server on your network
+  -h, --help         Show this help message
+```
+
+Requires the `pulumi` CLI to be installed and on `PATH`; it's used to fetch each provider's schema (`pulumi package get-schema`). If a schema was fetched successfully before, it's cached and reused if a later CLI call fails.
+
+## MCP
+
+The server also exposes an [MCP](https://modelcontextprotocol.io) endpoint at `/mcp` (Streamable HTTP), so a coding agent can look up the same local provider docs without browsing the site. Point an MCP client at `http://localhost:3000/mcp` (e.g. in Claude Code, `claude mcp add --transport http pulumi-package-docs http://localhost:3000/mcp`). Tools:
+
+- `list_providers` — the local providers declared in `Pulumi.yaml`, with resource/function counts and schema load status.
+- `list_resources` / `list_functions` — a provider's resource or function tokens, with a one-line summary and deprecation status for each.
+- `get_resource` / `get_function` — full docs for one resource or function: description, a usage example in the project's own language, and inputs/outputs (name, type, required, description).
+- `search_members` — keyword search across one or all providers' resources and functions, for when a provider is too large to list in full.
+
+## Development
+
+```bash
+npm install
+npm run dev
+```
+
+This starts the TanStack Start dev server, and inspects the Pulumi project in this repo's own directory by default. Point it at another project's `Pulumi.yaml` with the `PULUMI_LOCAL_DOCS_DIR` env var:
+
+```bash
+PULUMI_LOCAL_DOCS_DIR=/path/to/pulumi/project npm run dev
+```
+
+Routes live under `src/routes`; TanStack Router regenerates `src/routeTree.gen.ts` automatically. Pulumi project discovery and schema fetching live in `src/lib/pulumi`.
+
+Run the tests with:
+
+```bash
+npm test
+```
+
+Build the production app with:
+
+```bash
+npm run build
+```
+
+`bin/cli.js` is the `npx` entry point: it serves the production build with `vite preview` if one exists (`npm run build` first), otherwise falls back to `vite dev`.

package/bin/cli.js

@@ -0,0 +1,80 @@
+#!/usr/bin/env node
+import { existsSync } from 'node:fs'
+import { createRequire } from 'node:module'
+import { dirname, join, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { spawn } from 'node:child_process'
+
+const packageRoot = resolve(dirname(fileURLToPath(import.meta.url)), '..')
+const require = createRequire(import.meta.url)
+
+function parseArgs(argv) {
+  const options = { dir: process.cwd(), port: '3000', host: false }
+  for (let i = 0; i < argv.length; i++) {
+    const arg = argv[i]
+    if (arg === '--dir' || arg === '-d') {
+      options.dir = resolve(argv[++i])
+    } else if (arg === '--port' || arg === '-p') {
+      options.port = argv[++i]
+    } else if (arg === '--host') {
+      options.host = true
+    } else if (arg === '--help' || arg === '-h') {
+      options.help = true
+    }
+  }
+  return options
+}
+
+function printHelp() {
+  console.log(`pulumi-package-docs [options]
+
+Serves local documentation for the parameterized/local Pulumi providers used
+by a Pulumi project.
+
+Options:
+  -d, --dir <path>   Pulumi project directory to inspect (default: current directory)
+  -p, --port <port>  Port to serve on (default: 3000)
+  --host             Expose the server on your network
+  -h, --help         Show this help message
+`)
+}
+
+const options = parseArgs(process.argv.slice(2))
+
+if (options.help) {
+  printHelp()
+  process.exit(0)
+}
+
+const vitePkgJson = require.resolve('vite/package.json')
+const viteBin = join(dirname(vitePkgJson), 'bin', 'vite.js')
+
+const hasProductionBuild = existsSync(
+  join(packageRoot, 'dist', 'server', 'server.js'),
+)
+const viteArgs = [
+  hasProductionBuild ? 'preview' : 'dev',
+  '--port',
+  options.port,
+]
+if (options.host) viteArgs.push('--host')
+
+if (!hasProductionBuild) {
+  console.log(
+    'No production build found, starting the dev server instead (this is slower).',
+  )
+}
+console.log(`Serving provider docs for: ${options.dir}`)
+console.log(`MCP endpoint: http://localhost:${options.port}/mcp`)
+
+const child = spawn(process.execPath, [viteBin, ...viteArgs], {
+  cwd: packageRoot,
+  stdio: 'inherit',
+  env: { ...process.env, PULUMI_LOCAL_DOCS_DIR: options.dir },
+})
+
+child.on('exit', (code) => process.exit(code ?? 0))
+child.on('error', (err) => {
+  console.error('Failed to start pulumi-package-docs:', err)
+  process.exit(1)
+})

package/dist/client/assets/MemberDetail-CX9jiyic.js

@@ -0,0 +1 @@
+import{o as e}from"./useSelector-BIt42tGI.js";import{o as t}from"./index-CZRUHwIq.js";import{i as n,n as r,o as i,r as a}from"./token-oQmZfAP3.js";var o=e();function s({example:e}){return e?(0,o.jsxs)(`div`,{className:`code-example`,children:[(0,o.jsx)(`span`,{className:`code-example-lang`,children:e.language}),(0,o.jsx)(`pre`,{children:(0,o.jsx)(`code`,{children:e.code})})]}):(0,o.jsx)(`p`,{className:`empty-state`,children:`No examples in the schema.`})}function c(e){if(!e)return`any`;if(e.$ref){let t=e.$ref.split(`/`).pop()??e.$ref;return decodeURIComponent(t)}return e.type===`array`&&e.items?`${c(e.items)}[]`:e.type??`any`}function l(e){return e.replace(/([a-z0-9])([A-Z])/g,`$1_$2`).replace(/([A-Z]+)([A-Z][a-z])/g,`$1_$2`).toLowerCase()}function u(e){return e.length===0?e:e.charAt(0).toUpperCase()+e.slice(1)}function d(e,t){switch(t){case`python`:return l(e);case`go`:case`dotnet`:return u(e);default:return e}}function f({properties:e,required:t,runtime:n}){let r=Object.keys(e??{});if(r.length===0)return(0,o.jsx)(`p`,{className:`empty-state`,children:`None`});let a=new Set(t??[]);return(0,o.jsxs)(`table`,{className:`props-table`,children:[(0,o.jsx)(`thead`,{children:(0,o.jsxs)(`tr`,{children:[(0,o.jsx)(`th`,{children:`Name`}),(0,o.jsx)(`th`,{children:`Type`}),(0,o.jsx)(`th`,{children:`Required`}),(0,o.jsx)(`th`,{children:`Description`})]})}),(0,o.jsx)(`tbody`,{children:r.map(t=>{let r=e[t];return(0,o.jsxs)(`tr`,{children:[(0,o.jsx)(`td`,{children:(0,o.jsx)(`code`,{children:d(t,n)})}),(0,o.jsx)(`td`,{children:(0,o.jsx)(`code`,{children:c(r)})}),(0,o.jsx)(`td`,{children:a.has(t)?`yes`:`no`}),(0,o.jsx)(`td`,{children:i(r.description,n)??``})]},t)})})]})}function p({providerName:e,kind:c,displayName:l,token:u,description:d,deprecationMessage:p,runtime:m,inputProperties:h,requiredInputs:g,outputProperties:_,requiredOutputs:v}){let y=i(d,m),b=n(y),x=a(r(y),m);return(0,o.jsxs)(`main`,{className:`provider-detail`,children:[(0,o.jsxs)(t,{to:`/providers/$name`,params:{name:e},className:`back-link`,children:[`← Back to `,e]}),(0,o.jsx)(`h1`,{children:l}),(0,o.jsxs)(`p`,{className:`subtitle`,children:[(0,o.jsx)(`span`,{className:`badge ${c===`Resource`?`badge-resource`:`badge-function`}`,children:c}),` `,`· `,(0,o.jsx)(`code`,{children:u})]}),p&&(0,o.jsxs)(`p`,{className:`banner banner-warning`,children:[`Deprecated: `,p]}),b?.split(/\n{2,}/).map((e,t)=>(0,o.jsx)(`p`,{children:e},t)),(0,o.jsx)(`h2`,{children:`Example`}),(0,o.jsx)(s,{example:x}),(0,o.jsx)(`h2`,{children:`Inputs`}),(0,o.jsx)(f,{properties:h,required:g,runtime:m}),(0,o.jsx)(`h2`,{children:`Outputs`}),(0,o.jsx)(f,{properties:_,required:v,runtime:m})]})}export{p as t};