Benjamin Taylor
84dd86f2ed
The marked block that wires managed Intelligence is the region a hosted reader copies verbatim, and nothing checked it. Both gaps were deliberate: the parity manifest lists `src/app/api/copilotkit/**` under `allowedDivergence` for every instance it tracks, and no `docker-compose.test.yml` sets `COPILOTKIT_LICENSE_TOKEN`, so every smoke-tested starter takes the else arm and the `intelligence:` arm has never run in CI. The cost was already visible. The block's code was byte-identical in 21 of 22 starters, but its warning comment had drifted into five variants and the two `ms-agent-framework-*` starters shipped the `demo-user` stub with no warning at all. That drift is how the localhost default of OSS-981 survived in all 22 copies at once. Add `scripts/validate-intelligence-wiring-block.ts`, which greps the opening marker, compares every site against the north-star starter, and fails on the first line that differs. Two normalisations keep it usable: the block is dedented, because `agentcore` nests it deeper, and the else arm's runner name is masked, because `agentcore` runs `AgentCoreRunner` in front of a Bedrock session where an in-process runner has nothing to run. Everything else, comment text included, must match to the byte. Then unify the warning at all 22 sites on the fullest wording, which also says the id must exist in Intelligence or thread operations can fail. The check passes on day one, so it is a ratchet rather than a migration. It is a shape gate, not a content gate: 22 identically wrong copies still pass. What it guarantees is that a fix reaches all of them or none. Not covered: enrolling the `intelligence:` arm in the smoke path. That needs a license token in CI and a reachable endpoint from the compose network, and is tracked separately.
CopilotKit <> Mastra Starter
This is a starter template for building AI agents using Mastra and CopilotKit. It provides a modern Next.js application with integrated AI capabilities and a beautiful UI.
Prerequisites
Getting Started
- Add your OpenAI API key
# you can use whatever model Mastra supports
echo "OPENAI_API_KEY=your-key-here" >> .env
- Install dependencies using your preferred package manager:
# Using npm (default)
npm install
# Using pnpm
pnpm install
# Using yarn
yarn install
# Using bun
bun install
- Start the development server:
# Using npm (default)
npm run dev
# Using pnpm
pnpm dev
# Using yarn
yarn dev
# Using bun
bun run dev
This will start both the UI and agent servers concurrently.
Running a Channel
channel-host.mts mounts the same agent as an Intelligence Channel
(Slack, Teams). It requires INTELLIGENCE_API_KEY and a declared Channel in
.copilotkit/channels.json — set both up with copilotkit init or
copilotkit channels add, which write that file and the credentials your
.env needs, then:
npm run channel
The host reads which Channel to hold from .copilotkit/channels.json. If a
project declares more than one, set INTELLIGENCE_CHANNEL_NAME to pick one.
The host holds no provider credentials and exposes no provider endpoint — Intelligence owns the provider edge — so the same file works for every provider.
The Channel itself is declared in channels.mts — that is where to add commands,
reactions, or an onMention handler. channel-host.mts only owns the process
lifetime, and is byte-identical in every starter.
Once startup finishes, the log reports the truth per Channel:
Channel "<name>" is online.— the session is up and can send.Channel "<name>" is declared but no provider is attached yet.— a normal waiting state, not a failure. Runcopilotkit channels statusto see what setup remains.
Neither message proves the provider app is installed, reachable, or that anyone can message it — verify that separately (invite the bot, then message it) before treating the Channel as working.
Unlike the other starters, this one has no typecheck:channel script: the
host's import chain reaches src/mastra/**, which carries a pre-existing
type error unrelated to the Channel host (see the comment in
tsconfig.channel.json).
Available Scripts
The following scripts can also be run using your preferred package manager:
dev- Starts both UI and agent servers in development modedev:ui- Starts only the Next.js UI serverdev:agent- Starts only the Mastra agent serverdev:debug- Starts development servers with debug logging enabledbuild- Builds the application for productionstart- Starts the production serverchannel- Holds an Intelligence Channel open (see "Running a Channel" above)
Documentation
- Mastra Documentation - Learn more about Mastra and its features
- CopilotKit Documentation - Explore CopilotKit's capabilities
- Next.js Documentation - Learn about Next.js features and API
Contributing
Feel free to submit issues and enhancement requests!
License
This project is licensed under the MIT License - see the LICENSE file for details.
CopilotKit Intelligence & Threads (Optional)
CopilotKit Intelligence adds durable thread history and cross-session memory to
your agent. It requires a COPILOTKIT_LICENSE_TOKEN and a running local
Intelligence stack (Docker Desktop + a local Intelligence repo checkout).
Prerequisites
- Docker Desktop running
- A
COPILOTKIT_LICENSE_TOKEN(obtain from CopilotKit Cloud) - The Intelligence repo cloned
locally. The
docker-compose.intelligence.ymldefaults to a sibling directory at../../../Intelligencerelative to this starter; override with theINTELLIGENCE_REPOenv var if your checkout is elsewhere.
Start the intelligence stack
# From inside this starter directory:
docker compose -f docker-compose.intelligence.yml up -d --wait
First run builds the intelligence image from source (may take several minutes).
Verify the stack is healthy
docker compose -f docker-compose.intelligence.yml ps
All three services (postgres, redis, intelligence) should show healthy.
Set environment variables
Add the following to your .env file:
COPILOTKIT_LICENSE_TOKEN=your-license-token-here
INTELLIGENCE_API_URL=http://localhost:4204
INTELLIGENCE_GATEWAY_WS_URL=ws://localhost:4404
Then start the dev server as usual (npm run dev). Thread history and memory
features are activated automatically when COPILOTKIT_LICENSE_TOKEN is set.
Stop / reset
# Stop without removing data:
docker compose -f docker-compose.intelligence.yml down
# Full reset (removes postgres + redis volumes):
docker compose -f docker-compose.intelligence.yml down -v