Skip to content

Improvements Needed in Quickstart Server Documentation #205

@itsmattius

Description

@itsmattius

The Quickstart Server guide at https://docs.ag-ui.com/quickstart/server contains a few outdated steps and inaccuracies that may lead to setup issues or confusion for new developers. Below is a list of suggested improvements to ensure a smoother onboarding experience:

  1. Add Linux and Windows installation instructions for protoc:
    The current "Install build utilities" section only includes the command for macOS users (brew install protobuf). This leaves out users on other operating systems like Linux and Windows.

  2. Remove unnecessary global turbo installation:
    The documentation recommends installing turbo globally, but this isn’t necessary. turbo is already listed under devDependencies and is available via local pnpm scripts.

  3. Fix missing config in OpenAIServerAgent instantiation:
    In apps/dojo/src/agents.ts, the OpenAIServerAgent is instantiated without its required config argument.
    Current:

    new OpenAIServerAgent()

    Correct:

    new OpenAIServerAgent({ url: "http://localhost:8000/" })
  4. Correct path in Step 3 – Start the dojo and server:
    The documentation references the wrong folder path for starting the OpenAI integration server.
    Current:

    cd integrations/openai/server/python

    Correct:

    cd integrations/openai-server/server/python
  5. Update dev start command to use local package script:
    The guide currently suggests using turbo run dev, but pnpm run dev works just as well and uses the local dependency, reducing setup complexity.

    Suggested command:

    pnpm run dev
  6. Fix path again in Step 4 – Bridge OpenAI with AG-UI:
    Just like in Step 3, the referenced path to the Python server is incorrect.
    Current:

    cd integrations/openai/server/python

    Correct:

    cd integrations/openai-server/server/python
  7. Update outdated code in "Implement the Streaming Server":
    The code provided in this section is not compatible with the current version of the openai package and other modern dependencies. Attempting to use it leads to runtime errors or unsupported patterns.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions