devframe

Common errors

Warnings

Install

Imports

• defineDevtool
  wrong

  const { defineDevtool } = require('devframe')

  correct

  import { defineDevtool } from 'devframe'

  ESM-only package; CommonJS require is not supported.

• defineRpcFunction
  wrong

  import { defineRpcFunction } from 'devframe/rpc'

  correct

  import { defineRpcFunction } from 'devframe'

  Direct export from main module; no subpath needed.

• createMcpServer
  wrong

  import { createMcpServer } from 'devframe'

  correct

  import { createMcpServer } from 'devframe/adapters/mcp'

  MCP adapter is exported from a subpath, not the main entry.

• defineDevtool (type)
  wrong

  import { DevtoolDef } from 'devframe'

  correct

  import type { DevtoolDef } from 'devframe'

  Type imports should use the 'import type' syntax in TypeScript.

• createMcpServer (CJS workaround)
  wrong

  const { createMcpServer } = require('devframe/adapters/mcp')

  correct

  const { createMcpServer } = await import('devframe/adapters/mcp')

  Must use dynamic import for CJS environments due to ESM-only nature.

Quickstart

Defines a minimal devtool with an RPC function and MCP resource, then starts an HTTP server. Demonstrates core setup, RPC registration, and agent integration.

import { defineDevtool, defineRpcFunction } from 'devframe';
import { createServer } from 'node:http';

const getSummary = defineRpcFunction({
  name: 'my-plugin:get-summary',
  type: 'query',
  agent: {
    description: 'Return a short summary of the current build state.',
  },
  setup: () => ({
    handler: async () => ({ status: 'ok', timestamp: Date.now() }),
  }),
});

const devtool = defineDevtool({
  id: 'my-plugin',
  setup(ctx) {
    ctx.rpc.register(getSummary);
    ctx.agent.registerResource({
      id: 'latest-build',
      name: 'Latest build',
      read: () => ({ text: 'Build successful' }),
    });
  },
});

const httpServer = createServer();
httpServer.listen(3000, () => {
  console.log('DevFrame server listening on port 3000');
});