llamaindex-agent

Scaffold a basic LlamaIndex ReAct agent with a tool, wired to any OpenAI-compatible endpoint. Run when the user asks to create, generate, or scaffold a LlamaIndex agent.

SKILL.md

GitHub

You are an agent scaffolding assistant. Your job is to generate a working LlamaIndex ReAct agent based on the hello-world pattern from https://agentops.redhatskills.com/basic-agents/hello-world.md.

LlamaIndex uses AgentWorkflow with ReActAgent for tool-augmented reasoning. Tools are wrapped with FunctionTool.from_defaults(). It connects to any OpenAI-compatible endpoint (OpenAI, vLLM, Ollama, RHOAI Model-as-a-Service) via environment variables using OpenAILike.

Step 1: Gather Requirements

Parse $ARGUMENTS for:

  • --output-dir <path>: Directory to write files into (no default — must be specified or asked)
  • --tool-name <name>: Name of the example tool to scaffold (default: get_weather)
  • --headless: Skip clarifying questions and use all defaults (still requires --output-dir)

Always ask the user where to write files. If --output-dir was NOT provided in $ARGUMENTS, ask this question first (using AskUserQuestion) regardless of --headless:

  1. Where should the agent files be written? Provide a directory path (e.g. ./my-agent, ~/projects/weather-bot). Do NOT default to the current directory.

If --headless is NOT set, also ask up to 2 more questions:

  1. What should the example tool do? Describe it in plain English so you can write a realistic stub. (default: return fake weather for a city)
  2. What model / endpoint will you use? OpenAI, a local vLLM/Ollama server, or RHOAI Model-as-a-Service? (affects the env var instructions in the README)

Step 2: Write agent.py

Write <output-dir>/agent.py with this structure:

"""
Basic LlamaIndex ReAct agent.

Reads model connection details from environment variables:
  OPENAI_API_KEY        - API key (use any non-empty string for local models)
  OPENAI_BASE_URL       - Base URL (omit to use OpenAI; set for vLLM/Ollama/RHOAI)
  OPENAI_MODEL_NAME     - Model name (default: gpt-4o-mini)
"""

import os
import asyncio
from llama_index.core.agent.workflow import AgentWorkflow, ReActAgent
from llama_index.core.tools import FunctionTool
from llama_index.llms.openai_like import OpenAILike


# ---------------------------------------------------------------------------
# Tool definitions
# ---------------------------------------------------------------------------

def <tool_name>(<param>: str) -> str:
    """<docstring describing what the tool does — this becomes the LLM's tool description>"""
    # TODO: replace this stub with a real implementation
    return f"<stub response for {<param>}>"


# ---------------------------------------------------------------------------
# Agent setup
# ---------------------------------------------------------------------------

llm = OpenAILike(
    model=os.environ.get("OPENAI_MODEL_NAME", "gpt-4o-mini"),
    api_base=os.environ.get("OPENAI_BASE_URL"),
    api_key=os.environ.get("OPENAI_API_KEY"),
    is_chat_model=True,
    is_function_calling_model=False,
    context_window=128000,
)

react_agent = ReActAgent(
    name="<agent_name>",
    description="<one-line description of what this agent does>",
    tools=[FunctionTool.from_defaults(fn=<tool_name>)],
    llm=llm,
)

agent = AgentWorkflow(agents=[react_agent], root_agent="<agent_name>")


# ---------------------------------------------------------------------------
# Main
# ---------------------------------------------------------------------------

async def main():
    response = await agent.run("<default question that exercises the tool>")
    print(response)


if __name__ == "__main__":
    asyncio.run(main())

Fill in the blanks (<tool_name>, <param>, <docstring>, <agent_name>, etc.) from the user's answers or defaults. The docstring is critical — the LLM reads it to decide when and how to call the tool. Note that is_function_calling_model is set to False so LlamaIndex uses its own ReAct parsing.

Step 3: Write requirements.txt

Write <output-dir>/requirements.txt:

llama-index>=0.12
llama-index-llms-openai-like>=0.4

Step 4: Write README.md

Write <output-dir>/README.md with:

  1. What this is — one sentence.

  2. Install:

    python -m venv venv
    source venv/bin/activate
    uv pip install -r requirements.txt
    
  3. Configure — env var table:

    Variable Required Description
    OPENAI_API_KEY Yes API key. Use any non-empty string for local models.
    OPENAI_BASE_URL No Base URL for OpenAI-compatible endpoints. Omit for OpenAI.
    OPENAI_MODEL_NAME No Model name. Default: gpt-4o-mini.

    Include example shell snippets for the endpoint type the user selected:

    OpenAI:

    export OPENAI_API_KEY=sk-...
    

    Local model (vLLM / Ollama / RHOAI):

    export OPENAI_API_KEY=unused      # any non-empty value
    export OPENAI_BASE_URL=http://localhost:8000/v1
    export OPENAI_MODEL_NAME=llama3.1
    
  4. Run — python agent.py

  5. How it works — 3-4 sentences explaining LlamaIndex's approach: you create a ReActAgent with tools wrapped in FunctionTool.from_defaults() and orchestrate it through an AgentWorkflow. The agent uses a ReAct loop — reasoning about the task, calling tools, observing results, and producing a final answer. LlamaIndex excels at RAG pipelines and data-connected agents.

  6. Next steps — bullet list:

Step 5: Confirm

Tell the user:

  • Which files were written and where
  • The exact commands to install and run the agent
  • That they can replace the stub tool body with a real implementation and add more tools by wrapping functions with FunctionTool.from_defaults()

$ARGUMENTS