Skip to content

fadamakis/notebook

v0.1.1MIT

A small notebook that demonstrates a Codex plugin with an OpenAI UI.

GitHubOpen Website

Codex Plugin Starter

A thoughtful starting point for your next Codex plugin.

A working local MCP plugin with React, TypeScript, the official OpenAI Apps SDK UI, and a small notebook to make the pieces tangible. Start with the layout. Make the behavior your own.

Try it

Use this template to create your own repository, then:

npm ci
npm run dev

Open the local URL printed by Vite. Create a note, search, save a favorite, or switch appearance. The preview uses synthetic in-memory data and needs no API key.

Build your own plugin walks through identity, tools, UI, installation, and release.

What is included

  • An elegant responsive sample with a sidebar, searchable notes, favorites, and an accessible editor.
  • OpenAI UI buttons, inputs, textarea, badges, and icons; host theme and safe-area support.
  • Four MCP tools with validated inputs and structured results, usable with or without the UI.
  • A sidebar entrypoint, portable plugin manifest, compatibility manifest, and a marketplace.
  • A browser preview, model tests, real stdio smoke test, and official AppBridge browser test.
  • Self-contained packaging, dependency notices, checksums, and a release workflow.

Build and install locally

Node.js 22.13+ and npm are required.

npm run check
npm run package
codex plugin marketplace add ./artifacts/plugin
codex plugin add notebook@codex-plugin-starter

Open Notebook from the Codex sidebar in a current desktop app, or ask Codex to open Notebook. The package includes its UI and runtime dependencies; the receiving computer needs Node, not a source checkout. See installation and compatibility.

Development commands

CommandPurpose
npm run devInteractive browser preview
npm run checkTypes, model tests, production build, MCP smoke test, manifest validation
npm run test:uiResponsive interactions and production AppBridge test; run npx playwright install chromium first
npm run configure -- --name my-plugin --display-name "My Plugin" --author "Your Name" --repository you/my-pluginUpdate package, plugin, MCP, and marketplace identities
npm run packageBuild a fresh ZIP and local marketplace

Understand the pieces

Architecture · Build your plugin · Install and update · Release · Privacy

This is an independent community starter, not an official OpenAI product. It uses the official OpenAI UI library and MCP Extensions SDK.

MIT licensed. Bundled dependencies retain their own licenses; packaging includes third-party notices.