Getting started

This page is for developers using the Java API. To try Uzzo from the NetBeans IDE, see the NetBeans plugin. To install the Uzzo workflow skills in GitHub Copilot, Claude Code, or OpenCode, see Installing skills.

Requirements

  • Java 21+
  • Maven 3.9+
  • LangChain4j 1.21.0+

Build and test

mvn clean compile
mvn test

Basic setup

// Configure your LLM provider
StreamingChatModel chatModel = ... // e.g., OpenAI, Anthropic, Ollama

// Implement AskTools for your platform (CLI, web, GUI)
AskTools tools = new MyAskToolsImplementation();

// Create the agent
UzzoScopeAgent agent = UzzoAgentBuilder.ScopeAgentBuilder()
    .streamingChatModel(chatModel)
    .chatMemory(MessageWindowChatMemory.withMaxMessages(20))
    .tools(tools)
    .build();

Running a scope analysis

String prompt = """
    Build a web application for e-commerce using Node.js
    on AWS cloud platform with JWT authentication and Stripe payments.
    Architecture: microservices with REST API.
    """;

agent.scope(prompt)
    .onPartialResponse(System.out::print)
    .onCompleteResponse(response -> { })
    .onError(Throwable::printStackTrace)
    .start();
// The agent asks clarifying questions if it detects gaps,
// and streams a structured scope document when complete.

Implementing AskTools

Provide a platform-specific implementation of user interaction:

public class CliAskTools implements AskTools {

    @Override
    public String askQuestion(String question) {
        System.out.print(question + " ");
        return new Scanner(System.in).nextLine();
    }

    @Override
    public String askSingleChoice(String question, List<String> options) {
        // Present options, read selection
    }

    @Override
    public List<String> askMultipleChoice(String question, List<String> options) {
        // Present options, read multiple selections
    }

    @Override
    public boolean askConfirmation(String question) {
        // Present yes/no, read confirmation
    }
}