base on Prompt-To-Agent : Create custom engineering agents for your codebase <p align="center"> <a href="https://potpie.ai?utm_source=github"> <img src="https://github.com/user-attachments/assets/1a0b9824-833b-4c0a-b56d-ede5623295ca" width="318px" alt="Potpie AI logo" /> </a> </p> <br/> <p align="center"> <a href="https://trendshift.io/repositories/12918" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12918" alt="potpie-ai%2Fpotpie | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> </br> <br /> <a href="https://app.potpie.ai" rel="dofollow">App</a> | <a href="https://docs.potpie.ai" rel="dofollow">Documentation</a> | <a href="https://docs.potpie.ai/open-source" rel="dofollow">API Reference</a> | <a href="https://app.potpie.ai/newchat?repo=potpie-ai/potpie&branch=main" rel="dofollow">Chat with 🥧 Repo</a> <br /> </p> <p align="center"> <a href="https://github.com/potpie-ai/potpie/blob/main/LICENSE"> <img src="https://img.shields.io/github/license/potpie-ai/potpie" alt="Apache 2.0"> </a> <a href="https://github.com/potpie-ai/potpie"> <img src="https://img.shields.io/github/stars/potpie-ai/potpie" alt="GitHub Repo stars"> </a> </br> <a href="https://discord.gg/ryk5CMD5v6"> <img src="https://img.shields.io/badge/Join%20our-Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Join our Discord"> </a> </br> <a href="https://marketplace.visualstudio.com/items?itemName=PotpieAI.potpie-vscode-extension"> <img src="https://custom-icon-badges.demolab.com/badge/Visual%20Studio%20Code-0078d7.svg?logo=vsc&logoColor=white" alt="VS Code Extension"> </a> </br> <a href="https://twitter.com/intent/tweet?text=I%20created%20custom%20engineering%20agents%20for%20my%20codebase%20in%20minutes%20with%20potpie.ai%20@potpiedotai%20!🥧"> <img alt="tweet" src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social"> </a> </p> <h1 align="center"> Prompt-To-Agent: Create custom engineering agents for your code </h1> Potpie is an open-source platform that creates AI agents specialized in your codebase, enabling automated code analysis, testing, and development tasks. By building a comprehensive knowledge graph of your code, Potpie's agents can understand complex relationships and assist with everything from debugging to feature development. <p align="center"> <img width="1506" alt="Screenshot 2025-03-28 at 2 51 34 PM" src="https://github.com/user-attachments/assets/efa6b8ba-447b-474c-a62e-2c65940085ee" /> ## 📚 Table of Contents - [🥧 Why Potpie?](#why-potpie) - [🤖 Our Prebuilt Agents](#prebuilt-agents) - [🛠️ Tooling](#potpies-tooling-system) - [🚀 Getting Started](#getting-started) - [💡 Use Cases](#use-cases) - [🛠️ Custom Agents](#custom-agents-upgrade) - [🗝️ Accessing Agents via API Key](#accessing-agents-via-api-key) - [🎨 Make Potpie Your Own](#make-potpie-your-own) - [🤝 Contributing](#contributing) - [📜 License](#license) - [💪 Contributors](#-thanks-to-all-contributors) ## 🥧 Why Potpie? - 🧠 **Deep Code Understanding**: Built-in knowledge graph captures relationships between code components - 🤖 **Pre-built & Custom Agents**: Ready-to-use agents for common tasks + build your own - 🔄 **Seamless Integration**: Works with your existing development workflow - 📈 **Flexible**: Handles codebases of any size or language ## 🔌 VSCode Extension Bring the power of Potpie's AI agents directly into your development environment with our VSCode extension: - **Direct Integration**: Access all Potpie agents without leaving your editor - **Quick Setup**: Install directly from the [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=PotpieAI.potpie-vscode-extension) - **Seamless Workflow**: Ask questions, get explanations, and implement suggestions right where you code ## 🧩 Slack Integration Bring your custom AI agents directly into your team's communication hub with our Slack integration: - **Team Collaboration**: Access all Potpie agents where your team already communicates - **Effortless Setup**: Install and configure in under 2 minutes. Checkout [Potpie docs](https://docs.potpie.ai/extensions/slack) - **Contextual Assistance**: Get answers, code solutions, and project insights directly in your Slack threads 👉 Install the Potpie Slack App: [Here](https://slack.potpie.ai/slack/install) ## 🤖 Potpie's Prebuilt Agents Potpie offers a suite of specialized codebase agents for automating and optimizing key aspects of software development: - **Debugging Agent**: Automatically analyzes stacktraces and provides debugging steps specific to your codebase. - **Codebase Q&A Agent**: Answers questions about your codebase and explains functions, features, and architecture. - **Code Changes Agent**: Analyzes code changes, identifies affected APIs, and suggests improvements before merging. - **Integration Test Agent**: Generates integration test plans and code for flows to ensure components work together properly. - **Unit Test Agent**: Automatically creates unit test plan and code for individual functions to enhance test coverage. - **LLD Agent**: Creates a low level design for implementing a new feature by providing functional requirements to this agent. - **Code Generation Agent**: Generates code for new features, refactors existing code, and suggests optimizations. ## 🛠️ Potpie's Tooling System Potpie provides a set of tools that agents can use to interact with the knowledge graph and the underlying infrastructure: - **get_code_from_probable_node_name**: Retrieves code snippets based on a probable node name. - **get_code_from_node_id**: Fetches code associated with a specific node ID. - **get_code_from_multiple_node_ids**: Retrieves code snippets for multiple node IDs simultaneously. - **ask_knowledge_graph_queries**: Executes vector similarity searches to obtain relevant information. - **get_nodes_from_tags**: Retrieves nodes tagged with specific keywords. - **get_code_graph_from_node_id/name**: Fetches code graph structures for a specific node. - **change_detection**: Detects changes in the current branch compared to the default branch. - **get_code_file_structure**: Retrieves the file structure of the codebase. ## 🚀 Getting Started ### Prerequisites - Docker installed and running - Git installed (for repository access) - Python 3.10.x ### Potpie UI An easy to use interface to interact with your Agents ## Initialize the UI Submodule To initialize the submodule: ```bash git submodule update --init ``` ### 1. Navigate to the `potpie-ui` Directory ```bash cd potpie-ui ``` ### 2. Update the Main Branch and Checkout ```bash git checkout main git pull origin main ``` ### 3. Set Up the Environment Create a `.env` file in the `potpie-ui` directory and copy the required configuration from `.env.template`. ```bash cp .env.template .env ``` ### 4. Build the Frontend ```bash pnpm build ``` ### 5. Start the Application ```bash pnpm start ``` ### Setup Steps **Install Python 3.10** - Download and install Python 3.10 from the official Python website: https://www.python.org/downloads/release/python-3100/ 1. **Prepare Your Environment** - Create a `.env` file based on the `.env.template` - Add the following required configurations: ```bash isDevelopmentMode=enabled ENV=development POSTGRES_SERVER=postgresql://postgres:mysecretpassword@localhost:5432/momentum NEO4J_URI=bolt://127.0.0.1:7687 NEO4J_USERNAME=neo4j NEO4J_PASSWORD=mysecretpassword REDISHOST=127.0.0.1 REDISPORT=6379 BROKER_URL=redis://127.0.0.1:6379/0 CELERY_QUEUE_NAME=dev defaultUsername=defaultuser PROJECT_PATH=projects #repositories will be downloaded/cloned to this path on your system. {PROVIDER}_API_KEY=sk-proj-your-key #your provider key e.g. ANTHROPIC_API_KEY for Anthropic INFERENCE_MODEL=ollama_chat/qwen2.5-coder:7b #provider model name CHAT_MODEL=ollama_chat/qwen2.5-coder:7b #provider model name ``` **`INFERENCE_MODEL`** and **`CHAT_MODEL`** correspond to the models that will be used for generating knowledge graph and for agent reasoning respectively. These model names should be in the format of `provider/model_name` format or as expected by Litellm. For more information, refer to the [Litellm documentation](https://docs.litellm.ai/docs/providers). <br> - Create a Virtual Environment using Python 3.10: ``` python3.10 -m venv venv source venv/bin/activate - Install dependencies in your venv: ```bash pip install -r requirements.txt 2. **Start Potpie** To start all Potpie services: ```bash chmod +x start.sh ./start.sh ``` **Windows** ```powershell ./start.ps1 ``` This will: - Start required Docker services - Wait for PostgreSQL to be ready - Apply database migrations - Start the FastAPI application - Start the Celery worker 3. **Stop Potpie** To stop all Potpie services: ```bash ./stop.sh ``` **Windows** ```powershell ./stop.ps1 ``` This will gracefully stop: - The FastAPI application - The Celery worker - All Docker Compose services 4. **Authentication Setup** (Skip this step in development mode) ```bash curl -X POST 'http://localhost:8001/api/v1/login' \ -H 'Content-Type: application/json' \ -d '{ "email": "your-email", "password": "your-password" }' # Save the bearer token from the response for subsequent requests 5. **Initialize Repository Parsing** ```bash # For development mode: curl -X POST 'http://localhost:8001/api/v1/parse' \ -H 'Content-Type: application/json' \ -d '{ "repo_path": "path/to/local/repo", "branch_name": "main" }' # For production mode: curl -X POST 'http://localhost:8001/api/v1/parse' \ -H 'Content-Type: application/json' \ -d '{ "repo_name": "owner/repo-name", "branch_name": "main" }' # Save the project_id from the response 6. **Monitor Parsing Status** ```bash curl -X GET 'http://localhost:8001/api/v1/parsing-status/your-project-id' # Wait until parsing is complete 7. **View Available Agents** ```bash curl -X GET 'http://localhost:8001/api/v1/list-available-agents/?list_system_agents=true' # Note down the agent_id you want to use ``` 8. **Create a Conversation** ```bash curl -X POST 'http://localhost:8001/api/v1/conversations/' \ -H 'Content-Type: application/json' \ -d '{ "user_id": "your_user_id", "title": "My First Conversation", "status": "active", "project_ids": ["your-project-id"], "agent_ids": ["chosen-agent-id"] }' # Save the conversation_id from the response 9. **Start Interacting with Your Agent** ```bash curl -X POST 'http://localhost:8001/api/v1/conversations/your-conversation-id/message/' \ -H 'Content-Type: application/json' \ -d '{ "content": "Your question or request here", "node_ids":[] }' ``` 10. **View Conversation History** (Optional) ```bash curl -X GET 'http://localhost:8001/api/v1/conversations/your-conversation-id/messages/?start=0&limit=10' ``` ## 💡 Use Cases - **Onboarding**: For developers new to a codebase, the codebase QnA agent helps them understand the codebase and get up to speed quickly. Ask it how to setup a new project, how to run the tests etc >We tried to onboard ourselves with Potpie to the [**AgentOps**](https://github.com/AgentOps-AI/AgentOps) codebase and it worked like a charm : Video [here](https://youtu.be/_mPixNDn2r8). - **Codebase Understanding**: Answer questions about any library you're integrating, explain functions, features, and architecture. >We used the Q&A agent to understand the underlying working of a feature of the [**CrewAI**](https://github.com/CrewAIInc/CrewAI) codebase that was not documented in official docs : Video [here](https://www.linkedin.com/posts/dhirenmathur_what-do-you-do-when-youre-stuck-and-even-activity-7256704603977613312-8X8G). - **Low Level Design**: Get detailed implementation plans for new features or improvements before writing code. >We fed an open issue from the [**Portkey-AI/Gateway**](https://github.com/Portkey-AI/Gateway) project to this agent to generate a low level design for it: Video [here](https://www.linkedin.com/posts/dhirenmathur_potpie-ai-agents-vs-llms-i-am-extremely-activity-7255607456448286720-roOC). - **Reviewing Code Changes**: Understand the functional impact of changes and compute the blast radius of modifications. - **Debugging**: Get step-by-step debugging guidance based on stacktraces and codebase context. - **Testing**: Generate contextually aware unit and integration test plans and test code that understand your codebase's structure and purpose. ## 🛠️ Custom Agents [Upgrade ✨](https://potpie.ai/pricing) With Custom Agents, you can design personalized tools that handle repeatable tasks with precision. Key components include: - **System Instructions**: Define the agent's task, goal, and expected output - **Agent Information**: Metadata about the agent's role and context - **Tasks**: Individual steps for job completion - **Tools**: Functions for querying the knowledge graph or retrieving code ## 🗝️ Accessing Agents via API Key You can access Potpie Agents through an API key, enabling integration into CI/CD workflows and other automated processes. For detailed instructions, please refer to the [Potpie API documentation](https://docs.potpie.ai/agents/api-access). - **Generate an API Key**: Easily create an API key for secure access. - **Parse Repositories**: Use the Parse API to analyze code repositories and obtain a project ID. - **Monitor Parsing Status**: Check the status of your parsing requests. - **Create Conversations**: Initiate conversations with specific agents using project and agent IDs adn get a conversation id. - **Send Messages**: Communicate with agents by sending messages within a conversation. ## 🎨 Make Potpie Your Own Potpie is designed to be flexible and customizable. Here are key areas to personalize your own deployment: ### **Effortless Agent Creation**: Design custom agents tailored to your specific tasks using a single prompt. Utilize the following API to create your custom agents: ```bash curl -X POST "http://localhost:8001/api/v1/custom-agents/agents/auto" \ -H "Content-Type: application/json" \ -d '{ "prompt": "Aan agent that takes stacktrace as input and gives root cause analysis and proposed solution as output" }' ``` Read more about other custom agent APIs to edit and delete your custom agents in our [documentation](https://docs.potpie.ai/open-source/agents/create-agent-from-prompt). ### Tool Integration Edit or add tools in the `app/modules/intelligence/tools` directory for your custom agents. Initialise the tools in the `app/modules/intelligence/tools/tool_service.py` file and include them in your agent. ## 🤝 Contributing We welcome contributions! To contribute: 1. Fork the repository 2. Create a new branch (`git checkout -b feature-branch`) 3. Make your changes 4. Commit (`git commit -m 'Add new feature'`) 5. Push to the branch (`git push origin feature-branch`) 6. Open a Pull Request See [Contributing Guide](./contributing.md) for more details. ## 📜 License This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details. ## 💪 Thanks To All Contributors Thanks for spending your time helping build Potpie. Keep rocking 🥂 <img src="https://contributors-img.web.app/image?repo=potpie-ai/potpie" alt="Contributors"/> ", Assign "at most 3 tags" to the expected json: {"id":"12918","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"