Add documentation for Settings and Secrets API examples

[malhotra5]

Summary

Adds documentation for the Settings and Secrets API examples in the software-agent-sdk.

Examples Documented

• examples/02_remote_agent_server/12_settings_and_secrets_api.py - Settings and Secrets API workflow
• examples/02_remote_agent_server/13_workspace_get_llm.py - Workspace settings retrieval methods

Documentation Covers

1. Settings API

   • Storing LLM configuration via /api/settings
   • Encrypted storage with OH_SECRET_KEY

2. Secrets API

   • CRUD operations for custom secrets
   • LookupSecret references for lazy resolution

3. Workspace Settings Methods

   • workspace.get_llm() - Retrieve configured LLM
   • workspace.get_secrets() - Get LookupSecret references
   • workspace.get_mcp_config() - Get MCP configuration

4. Security

   • Session API key authentication
   • API key headers in LookupSecrets

Related SDK PR

• Add get_llm(), get_secrets(), and get_mcp_config() methods to RemoteWorkspace software-agent-sdk#3077

Note: The branch name matches the SDK PR branch (remote-workspace-settings-methods) so the SDK CI can find these docs.

---

This PR was created by an AI agent (OpenHands) on behalf of the user.

@malhotra5 can click here to continue refining the PR

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
all-hands-ai	🟢 Ready	View Preview	May 6, 2026, 3:50 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

[xingyaoww]

We should add this to docs.json - @OpenHands please update this in the custom code review guideline so we can prevent this in th efuture

[all-hands-bot]

Taste Rating: 🟡 Acceptable - Well-written documentation with one navigation issue

[CRITICAL ISSUE]

• Navigation Configuration: The new page sdk/guides/agent-server/settings-api.mdx is missing from docs.json. It must be added to the "Remote Agent Server" group navigation (currently lists overview, local-server, docker-sandbox, apptainer-sandbox, api-sandbox, cloud-workspace, custom-tools). Without this entry, users won't find the page in the sidebar.

[POSITIVE NOTES]

• Documentation follows SDK guidelines correctly
• Good use of auto-sync code block placeholders
• Comprehensive security guidance
• Clear structure with appropriate examples
• Proper Mintlify component usage

[RISK ASSESSMENT]
⚠️ Risk Assessment: 🟢 LOW
Documentation-only change. No code modifications, no breaking changes. Content quality is high.

VERDICT:
❌ Needs rework - Add the page to docs.json navigation before merging.

KEY INSIGHT:
Excellent documentation of Settings and Secrets API with proper security emphasis, but missing navigation entry prevents discoverability.

[all-hands-bot]

Taste Rating: 🟢 Good taste - Well-structured documentation following repository conventions

[RISK ASSESSMENT]

• [Overall PR] ⚠️ Risk Assessment: 🟢 LOW
  Documentation-only changes adding Settings and Secrets API guide. Navigation properly configured, code block syntax correct for auto-sync, security considerations appropriately covered.

VERDICT:
✅ Worth merging: Clean documentation with proper structure and conventions

KEY INSIGHT:
The placeholder code blocks (<code will be auto-synced>) are expected behavior - the sync workflow will automatically populate them from the referenced example files in the agent-sdk repository.