Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pluxx.dev/llms.txt

Use this file to discover all available pages before exploring further.

pluxx.config.ts is the plugin source of truth. 
import { definePlugin } from '@orchid-labs/pluxx'

export default definePlugin({
  name: 'my-plugin',
  description: 'What your plugin does',
  author: { name: 'Your Name' },
  mcp: {
    'my-server': {
      url: 'https://api.example.com/mcp',
      auth: { type: 'bearer', envVar: 'API_KEY' }
    }
  },
  skills: './skills/',
  targets: ['claude-code', 'cursor', 'codex', 'opencode']
})

​
What belongs here

pluxx.config.ts defines the source project that Pluxx compiles into host-native bundles. Common fields:
  • name Stable plugin id used for generated output and install paths.
  • description Shared plugin summary used across generated outputs.
  • author Plugin author metadata.
  • mcp One or more MCP server definitions, including transport and auth.
  • skills Path to the skills directory.
  • commands Path to the commands directory when you want explicit command surfaces.
  • instructions Path to the shared instruction file.
  • scripts Path to generated or hand-authored helper scripts such as hook helpers.
  • targets Which host bundles to build.

​
MCP auth examples

Bearer token: 
mcp: {
  sumble: {
    url: 'https://mcp.sumble.com',
    auth: { type: 'bearer', envVar: 'SUMBLE_API_KEY' }
  }
}
Custom header: 
mcp: {
  playkit: {
    url: 'https://mcp.playkit.sh/mcp',
    auth: {
      type: 'header',
      envVar: 'PLAYKIT_API_KEY',
      headerName: 'X-API-Key',
      headerTemplate: '${value}'
    }
  }
}
Platform-managed runtime auth: 
platforms: {
  'claude-code': { mcpAuth: 'platform' },
  cursor: { mcpAuth: 'platform' }
}

​
Source vs generated output

Keep editing the source project:
  • pluxx.config.ts
  • INSTRUCTIONS.md
  • skills/
  • commands/
  • scripts/
Treat dist/* as generated output from pluxx build.

​
Next references