initial commit

Signed-off-by: Tyler Slaton <tyler@copilotkit.ai>

Author: tylerslaton

.gitignore

@@ -0,0 +1,54 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# env files (can opt-in for committing if needed)
+.env*
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+.mastra/
+
+# lock files
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+bun.lockb
+
+# python
+agent/venv/
+agent/__pycache__/
+.venv/

LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Atai Barkai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,119 @@
+# CopilotKit <> LlamaIndex Starter
+
+This is a starter template for building AI agents using [LlamaIndex](https://llamaindex.com) and [CopilotKit](https://copilotkit.ai). 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.8+
+- OpenAI API Key (for the LlamaIndex agent)
+- [uv](https://docs.astral.sh/uv/getting-started/installation/)
+- Any of the following package managers:
+  - pnpm (recommended)
+  - npm
+  - yarn
+  - bun
+
+> **Note:** This repository ignores lock files (package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lockb) to avoid conflicts between different package managers. Each developer should generate their own lock file using their preferred package manager. After that, make sure to delete it from the .gitignore.
+
+## Getting Started
+
+1. Install dependencies using your preferred package manager:
+```bash
+# Using pnpm (recommended)
+pnpm install
+
+# Using npm
+npm install
+
+# Using yarn
+yarn install
+
+# Using bun
+bun install
+```
+
+2. Install Python dependencies for the LlamaIndex agent:
+```bash
+# Using pnpm
+pnpm install:agent
+
+# Using npm
+npm run install:agent
+
+# Using yarn
+yarn install:agent
+
+# Using bun
+bun run install:agent
+```
+
+3. Set up your OpenAI API key:
+```bash
+export OPENAI_API_KEY="your-openai-api-key-here"
+```
+
+4. Start the development server:
+```bash
+# Using pnpm
+pnpm dev
+
+# Using npm
+npm run 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 mode
+- `dev:debug` - Starts development servers with debug logging enabled
+- `dev:ui` - Starts only the Next.js UI server
+- `dev:agent` - Starts only the LlamaIndex agent server
+- `install:agent` - Installs Python dependencies for the agent
+- `build` - Builds the Next.js application for production
+- `start` - Starts the production server
+- `lint` - 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](https://docs.llamaindex.com/introduction) - Learn more about LlamaIndex and its features
+- [CopilotKit Documentation](https://docs.copilotkit.ai) - Explore CopilotKit's capabilities
+- [Next.js Documentation](https://nextjs.org/docs) - Learn about Next.js features and API
+- [YFinance Documentation](https://pypi.org/project/yfinance/) - 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:
+1. The LlamaIndex agent is running on port 8000
+2. Your OpenAI API key is set correctly
+3. Both servers started successfully
+
+### Python Dependencies
+If you encounter Python import errors:
+```bash
+cd agent
+uv sync
+```

agent/README.md

@@ -0,0 +1,19 @@
+# Llama Index Agent Starter: Python
+
+This package is a quick starter example for building AG-UI agents with Llama Index and CopilotKit.
+
+## Running the Backend
+
+```bash
+export OPENAI_API_KEY=...
+uv sync
+uv run dev
+```
+
+## Running the Frontend
+
+```bash
+cd ../ui
+npm install
+npm run dev
+```

agent/agent/__init__.py

@@ -0,0 +1,10 @@
+import uvicorn
+from .server import app
+
+def main():
+    uvicorn.run(app, host="127.0.0.1", port=9000)
+
+if __name__ == "__main__":
+    main()
+
+__all__ = ["app"]

agent/agent/__pycache__/__init__.cpython-313.pyc

@@ -0,0 +1,49 @@
+from typing import Annotated
+
+from llama_index.core.workflow import Context
+from llama_index.llms.openai import OpenAI
+from llama_index.protocols.ag_ui.events import StateSnapshotWorkflowEvent
+from llama_index.protocols.ag_ui.router import get_ag_ui_workflow_router
+
+
+# This tool has a client-side version that is actually called to change the background
+def change_theme_color(
+    theme_color: Annotated[str, "The hex color value. i.e. '#123456''"],
+) -> str:
+    """Change the background color of the chat. Can be any hex color value."""
+    return f"Changing background to {theme_color}"
+
+async def add_proverb(
+    ctx: Context,
+    proverb: Annotated[str, "The proverb to add. Make it witty, short and concise."],
+) -> str:
+    """Add a proverb to the list of proverbs."""
+    state = await ctx.get("state", default={})
+
+    if "proverbs" not in state:
+        state["proverbs"] = []
+        
+    state["proverbs"].append(proverb)
+    ctx.write_event_to_stream(StateSnapshotWorkflowEvent(snapshot=state))
+
+    await ctx.set(state)
+
+    return f"Added proverb: {proverb}"
+
+async def get_weather(
+    location: Annotated[str, "The location to get the weather for."],
+) -> str:
+    """Get the weather for a given location."""
+    return f"The weather in {location} is sunny and 70 degrees."
+
+agentic_chat_router = get_ag_ui_workflow_router(
+    llm=OpenAI(model="gpt-4.1"),
+    frontend_tools=[change_theme_color, add_proverb],
+    backend_tools=[get_weather],
+    system_prompt="You are a helpful assistant that can add proverbs to a list, get the weather for a given location, and change the background color of the chat/app background.",
+    initial_state={
+        "proverbs": [
+            "CopilotKit may be new, but its the best thing since sliced bread.",
+        ],
+    },
+)

agent/agent/__pycache__/agent.cpython-313.pyc

@@ -0,0 +1,5 @@
+from fastapi import FastAPI
+from .agent import agentic_chat_router
+
+app = FastAPI()
+app.include_router(agentic_chat_router)