Skip to content

(examples revamp): remove redundant files#5523

Merged
tinalenguyen merged 10 commits into
mainfrom
tina/revamp-examples
Jul 13, 2026
Merged

(examples revamp): remove redundant files#5523
tinalenguyen merged 10 commits into
mainfrom
tina/revamp-examples

Conversation

@tinalenguyen

@tinalenguyen tinalenguyen commented Apr 22, 2026

Copy link
Copy Markdown
Member

these examples will be removed because they are already present in another example or are already in the docs:

file reason for removal
./avatar_agents all documented on respective plugin pages
./other/text-to-speech docs
background_audio.py docs
email_example.py built in via GetEmailTask()
nvidia_test.py functionally equivalent to basic_agent.py
realtime_video_agent.py docs
realtime_with_tts.py docs
web_search.py opt for provider tools instead
silent_function_call.py docs for cancel_tool_reply
phonic_realtime_agent.py docs
multi_agent.py favor examples and restaurant agent
realtime_turn_detector.py docs
session_close_callback.py docs
resume_interrupted_agent.py docs
realtime_load_chat_history.py docs
annotated_tool_args.py displayed in full examples
timed_agent_transcript.py <!> need docs for getting json format timed transcript, docs
speedup_output_audio.py <!> should be added to docs here
ultravox_realtime_api.py docs
dynamic_tool_creation.py docs
zapier_mcp_integration.py docs
weather_agent.py dupe of basic_agent.py
structured_output.py docs
toggle_io.py docs
speaker_id_multi_speaker.py docs
raw_function_description.py docs
inactive_user.py <!> maybe needs docs
langgraph_agent.py <!> maybe needs more docs here
long_running_function.py <!> docs lead straight to the github example, we should add docs on it in Advanced LLM tab
minimal_worker.py too minimal?
elevenlab_scribe_v2.py docs
kokoro_tts.py <!> should we opt for openai.TTS.with_kokoro()?
legacy_api.py old, dupe of minimal worker
video-publisher.py docs
translator.py select STT providers natively support this
flush_llm_node.py <!> maybe needs docs
text_only.py docs
transcriber.py docs
participant_entrypoint.py <!> maybe needs more docs here
e2ee.py docs
file action
realtime_joke_teller.py <!> document nova sonic specific function tool outputs
push_to_talk.py <!> should be documented
async_tool_agent.py <!> should be documented
fast-preresponse.py <!> should be documented
error_callback.py <!> should be documented
langfuse_trace.py <!> should be documented
instructions_per_modality.py <!> should be documented
restaurant.py <!> should be documented
tool_search_agent.py <!> should be documented

@tinalenguyen
tinalenguyen marked this pull request as ready for review April 27, 2026 18:01
@chenghao-mou
chenghao-mou requested a review from a team April 27, 2026 18:01
devin-ai-integration[bot]

This comment was marked as resolved.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 new potential issue.

🐛 1 issue in files not directly in the diff

🐛 Missing follow_redirects=True in streamable HTTP client causes redirect failures (livekit-agents/livekit/agents/llm/mcp.py:309-312)

The old _create_http_client method (removed in this PR) explicitly set follow_redirects=True when creating the httpx.AsyncClient. The new inline client creation at livekit-agents/livekit/agents/llm/mcp.py:309 omits this parameter, and httpx.AsyncClient defaults to follow_redirects=False. This means any MCP server behind a redirect (common for auth flows, load balancers, CDNs) will fail with the streamable HTTP transport. The old factory was documented as "ported from mcp.shared._httpx_utils.create_mcp_http_client", suggesting redirect support is expected behavior for MCP clients.

View 7 additional findings in Devin Review.

Open in Devin Review

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 4 new potential issues.

View 5 additional findings in Devin Review.

Open in Devin Review

Comment thread examples/README.md

@devin-ai-integration devin-ai-integration Bot Jun 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 Main README description of 'Other' and 'Primitives' directories is now stale

The main examples/README.md (unchanged lines 41–47) still describes other/ as containing "text-only agents, various TTS providers, transcription services, and translation utilities" and primitives/ as covering "participant management, and basic audio/video handling." However, this PR deletes text_only.py, the entire text-to-speech/ directory, transcriber.py, translator.py, participant_entrypoint.py, video-publisher.py, and e2ee.py. After the deletions, other/ contains only cartesia.py, chat-stream-receiver.py, multi-user-transcriber.py, and multi-user-translator.py; primitives/ contains only echo-agent.py and room_stats.py. The descriptions are now misleading. Similarly, examples/other/README.md:3 and examples/primitives/README.md:3 have the same stale descriptions.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚩 Phonic plugin README references deleted example

The file livekit-plugins/livekit-plugins-phonic/README.md:77 references voice_agents/phonic_realtime_agent.py which was deleted in this PR. This is a minor external broken reference outside the examples directory.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

@devin-ai-integration devin-ai-integration Bot Jun 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 Deleted examples are referenced from the docs site — external link breakage not verifiable here

The new banner at examples/README.md:3 directs users to the LiveKit docs site for examples. If the docs site links back to specific deleted example files in this repo (e.g., avatar_agents/anam/agent_worker.py, voice_agents/weather_agent.py, voice_agents/multi_agent.py), those links would break. This cannot be verified from the repo alone but is worth confirming before merge.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Comment thread examples/README.md
Comment on lines +3 to +4
> **Looking for examples and guides?** Most examples now live in the [LiveKit docs](https://docs.livekit.io/agents/). Browse the full collection of runnable examples and recipes on the [Recipes page](https://docs.livekit.io/reference/recipes).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚩 Root README.md has broken links to deleted example files

The root README.md (not part of this diff) contains a showcase table with links to several files deleted in this PR:

  • README.md:268examples/voice_agents/background_audio.py (deleted)
  • README.md:275examples/voice_agents/dynamic_tool_creation.py (deleted)
  • README.md:292examples/voice_agents/structured_output.py (deleted)
  • README.md:309examples/other/text_only.py (deleted)
  • README.md:326examples/avatar_agents/ (deleted)
  • README.md:150examples/voice_agents/multi_agent.py (deleted)

These are now dead links visible on the project's main GitHub page. The root README should be updated as part of this cleanup.

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

@tinalenguyen
tinalenguyen merged commit 03ab627 into main Jul 13, 2026
23 checks passed
@tinalenguyen
tinalenguyen deleted the tina/revamp-examples branch July 13, 2026 03:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants