-
Notifications
You must be signed in to change notification settings - Fork 698
Description
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:
-
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. -
Remove unnecessary global turbo installation:
The documentation recommends installingturbo
globally, but this isn’t necessary.turbo
is already listed underdevDependencies
and is available via localpnpm
scripts. -
Fix missing config in OpenAIServerAgent instantiation:
Inapps/dojo/src/agents.ts
, theOpenAIServerAgent
is instantiated without its requiredconfig
argument.
Current:new OpenAIServerAgent()
Correct:
new OpenAIServerAgent({ url: "http://localhost:8000/" })
-
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
-
Update dev start command to use local package script:
The guide currently suggests usingturbo run dev
, butpnpm run dev
works just as well and uses the local dependency, reducing setup complexity.Suggested command:
pnpm run dev
-
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
-
Update outdated code in "Implement the Streaming Server":
The code provided in this section is not compatible with the current version of theopenai
package and other modern dependencies. Attempting to use it leads to runtime errors or unsupported patterns.