Skip to content

SDK: Remote Agent Server documentation#45

Merged
enyst merged 46 commits into
mainfrom
xw/sdk
Oct 23, 2025
Merged

SDK: Remote Agent Server documentation#45
enyst merged 46 commits into
mainfrom
xw/sdk

Conversation

@xingyaoww

Copy link
Copy Markdown
Member
  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

xingyaoww and others added 30 commits October 21, 2025 14:14
- Standardized all 30 SDK guide files with consistent format:
  - Added <Note> components with GitHub example links
  - Used auto-sync code blocks with 'icon' and 'expandable' attributes
  - Added 'Running the Example' bash code blocks
  - Included brief explanations with line highlights
  - Added 'Next Steps' sections with related links

- Merged anthropic-thinking.mdx and responses-reasoning.mdx into model-reasoning.mdx:
  - Created unified guide covering both Anthropic thinking blocks and OpenAI responses reasoning
  - Single example demonstrating both approaches
  - Deleted old separate documentation files

- Updated docs.json navigation:
  - Organized all SDK guides into logical categories:
    * Getting Started (hello-world, custom-tools, mcp)
    * Agent Configuration (llm-registry, llm-routing, model-reasoning)
    * Conversation Management (persistence, pause-and-resume, confirmation-mode, etc.)
    * Agent Capabilities (activate-skill, async, planning-agent-workflow, etc.)
    * Agent Behavior (stuc    * Agent Behavior (stuc    * Agent Behavior (stuc    * Ag n    * Agent Behavior (stuc    * Agent Behavnces in sdk/arch/sdk/llm.mdx

Co-authored-by: openhands <openhands@all-hands.dev>
Synced from agent-sdk ref: main
Synced from agent-sdk ref: main
@xingyaoww xingyaoww marked this pull request as ready for review October 22, 2025 21:55
@xingyaoww xingyaoww requested a review from enyst as a code owner October 22, 2025 21:55
Comment thread sdk/guides/agent-server/api-sandbox.mdx Outdated
```


## What is a Remote Agent Server?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
## What is a Remote Agent Server?
## What is an Agent Server?

I feel this is going to be confusing: "Remote" includes Local, Docker, and API... 🤔

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm not sure it's because we use a workspace in all cases 🤔

Idk, in any case, if we rename, there is more to rename below

Server --> Workspace[Workspace]

subgraph Workspace Types
Workspace --> Local[Local Folder]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Here we have "Local", and yes, I think we'd be better off to just name this section and usages in it simply "Agent Servers"...

Comment thread sdk/guides/agent-server/docker-sandbox.mdx
@enyst

enyst commented Oct 23, 2025

Copy link
Copy Markdown
Member

Wow, oops! 😂
The battle of an AI agent vs a hardcoded workflow - the hardcoded workflow was winning, until the agent figured it out and modified the workflow! 😅 😂

A screenshot for posterity, before I reset --hard
image

So last night I wanted OH to

  • fix the source example scripts, and
  • make a PR to agent-sdk repo

But I didn't prompt clearly, on the contrary I said 'docs' for some reason. So it committed here, on the synced copy. The sync bot didn't like it 😂 ...and the rest is history.

(I copied this branch with the battle locally for fun: OpenHands-GPT-5 has occasionally ThinkAction blocks, and I see how it happened: it progressively convinced itself that it has to silence the sync workflow. It knew it shouldn't really edit the copy, but it did it once and silenced the sync, had condensation between, and then it told itself it was already there so may as well add to it! 😅 )

…r code blocks\n\n- Use LLM_API_KEY and RUNTIME_API_URL in run instructions\n- Keep runtime.eval.all-hands.dev until openhands runtime domain is live\n- Do not modify synced code blocks; changes will come via agent-sdk PR #872\n\nCo-authored-by: openhands <openhands@all-hands.dev>\n
Comment thread sdk/guides/agent-server/api-sandbox.mdx Outdated
Comment thread sdk/guides/agent-server/api-sandbox.mdx Outdated

@enyst enyst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I love a lot, a lot, the persistent descriptions of seamless passage from local to remote! I actually read it all, in detail, all added docs. 😅

Made only some tiny tweaks. I do think we will need to adjust somehow the "Remote Agent Server" and some related occurrences, to probably "Agent Server". But I'm leaving it alone for now, maybe there's something to think about there, or maybe we can adjust it at the next confusion.

@enyst enyst merged commit d3f4c8d into main Oct 23, 2025
2 checks passed
@mamoodi mamoodi deleted the xw/sdk branch October 26, 2025 16:02
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