osworld-version_skill

Overview

This skill retrieves API version information from an OSWorld server and returns both human-readable text and raw metadata. It reports the API version, server version, and protocol used by the server. No input parameters are required; the tool reads configuration from environment or character config.

How this skill works

When invoked, the skill queries the configured OSWorld endpoint and parses the server's version response. It formats a text summary and attaches raw metadata fields: api_version, server_version, and protocol. Configuration is taken from the OSWORLD_URL environment variable or from osworld_config in character settings.

When to use it

• Validate which API version an OSWorld instance is running before integration or testing.
• Check protocol compatibility (for example http/json) prior to making API calls.
• Automated CI/CD checks that require verifying server version or API compatibility.
• Quick diagnostics when an environment behaves differently across deployments.

Best practices

• Set OSWORLD_URL to the correct endpoint in environment variables for each deployment stage.
• Include a step that logs the returned metadata (api_version, server_version, protocol) in diagnostic runs.
• Use the returned protocol field to decide client behavior (e.g., JSON vs other formats).
• Treat the tool as read-only: it only inspects version data and does not alter server state.

Example use cases

• Pre-deployment script that fails the pipeline if api_version does not match supported versions.
• Health-check endpoint that includes the formatted version summary for operator dashboards.
• Debugging session where you must confirm whether a staging server uses the same server_version as production.