mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Mike Ryan
d5b804698d
## What 1. Add `suppressHydrationWarning` to `<body>` across **all 14 integration demo templates** (`examples/integrations/*/src/app/layout.tsx`). 2. Fix a pre-existing **double-escaped Windows path** bug in the parity manifest's `packageJsonOverrides`. ## Why (hydration) **Mike Ryan hit a hydration error on first load of a fresh `langgraph-python` init — caused by his Grammarly browser extension.** Grammarly (and similar extensions) inject attributes onto `<body>` *before* React hydrates: ``` data-new-gr-c-s-check-loaded="9.98.0" data-gr-ext-installed="" ``` Those attributes are in the client DOM but absent from the server HTML, so Next.js reports: > A tree hydrated but some attributes of the server rendered HTML didn't match the client properties. It's a **false positive** — the app works, and end users (without dev extensions) never see it — but it's a red console error on the first load of our flagship eval/showcase templates, which is a poor first impression. ## Fix (hydration) `suppressHydrationWarning` on `<body>` is the React/Next.js-recommended escape hatch for this. It is **scoped and one level deep**: it only relaxes the check for `<body>`'s *own* attributes/text — **everything rendered inside `<body>` (the whole app) is still fully hydration-checked** — and `<body>`'s only attribute here is a static `className`, so none of our own markup is masked. An inline comment documents this so a future maintainer who adds dynamic `<body>` attributes knows the check is relaxed. `agent-spec` already had `suppressHydrationWarning` on `<html>`; the Grammarly attributes land on `<body>`, so it needed the body-level relaxation too (the `<html>` one is a level up and doesn't cover `<body>`'s attributes). ## Commits 1. `b1fa482a7` — north-star (`langgraph-python`) + parity instances (`langgraph-js`, `langgraph-fastapi`, `strands-python`) via `pnpm parity:sync`. 2. `9f9c415d9` — the non-parity templates (not tracked by `_parity/manifest.json`): `adk`, `agno`, `crewai-crews`, `crewai-flows`, `llamaindex`, `mastra`, `ms-agent-framework-dotnet`, `ms-agent-framework-python`, `pydantic-ai`, `agent-spec`. *(The repo's `oxfmt` pre-commit hook also collapsed some multiline `<CopilotKit …>` JSX in these files — standard auto-format on touched files; the only semantic change is the suppression.)* 3. `7d60e49de` — parity manifest path-escaping fix (see below). ## The manifest bug (commit 3) While syncing I found the `langgraph-js` and `strands-python` `packageJsonOverrides` double-escaped the Windows `.bat` fallback, producing `scripts\\run-agent.bat` (two backslashes) instead of `scripts\run-agent.bat`: - `langgraph-js/package.json` had already been synced with the broken value. - `strands-python/package.json` was still correct — and `parity:sync` would have **corrupted** it on the next run (which is what surfaced this). Fixed the three overrides and re-ran `parity:sync`, which corrects `langgraph-js/package.json` and leaves `strands-python`'s correct value intact. ## Test plan - [x] `pnpm parity:verify` → 0 errors - [x] lefthook pre-commit green on all 3 commits (lint + `packages/**` tests + commitlint) - [x] All 14 templates confirmed to have body-level `suppressHydrationWarning` - [ ] Reviewer with Grammarly installed: run/`init` a template and confirm no hydration error on first load
CopilotKit <> LlamaIndex Starter
This is a starter template for building AI agents using LlamaIndex and CopilotKit. It provides a modern Next.js application with an integrated investment analyst agent that can research stocks, analyze market data, and provide investment insights.
Prerequisites
- Node.js 18+
- Python 3.9+
- OpenAI API Key (for the LlamaIndex agent)
- uv
- Any of the following package managers:
Getting Started
- Install dependencies using your preferred package manager:
# Using npm (default)
npm install
# Using pnpm
pnpm install
# Using yarn
yarn install
# Using bun
bun install
This also installs the Python agent dependencies via uv sync.
- Set up your OpenAI API key:
export OPENAI_API_KEY="your-openai-api-key-here"
- 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.
Available Scripts
The following scripts can also be run using your preferred package manager:
dev- Starts both UI and agent servers in development modedev:debug- Starts development servers with debug logging enableddev:ui- Starts only the Next.js UI serverdev:agent- Starts only the LlamaIndex agent serverinstall:agent- Installs Python dependencies for the agentbuild- Builds the Next.js application for productionstart- Starts the production serverlint- Runs ESLint for code linting
Documentation
The main UI component is in src/app/page.tsx. You can:
- Modify the theme colors and styling
- Add new frontend actions
- Customize the CopilotKit sidebar appearance
📚 Documentation
- LlamaIndex Documentation - Learn more about LlamaIndex and its features
- CopilotKit Documentation - Explore CopilotKit's capabilities
- Next.js Documentation - Learn about Next.js features and API
- YFinance Documentation - Financial data tools
Contributing
Feel free to submit issues and enhancement requests! This starter is designed to be easily extensible.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Troubleshooting
Agent Connection Issues
If you see "I'm having trouble connecting to my tools", make sure:
- The LlamaIndex agent is running on port 9000
- Your OpenAI API key is set correctly
- Both servers started successfully
Python Dependencies
If you encounter Python import errors:
cd agent
uv sync