home / skills / bdambrosio / cognitive_workbench / osworld-version

osworld-version skill

/src/world-tools/osworld/osworld-version

This skill retrieves the OSWorld API version, server version, and protocol from the configured endpoint and returns structured details.

npx playbooks add skill bdambrosio/cognitive_workbench --skill osworld-version

Review the files below or copy the command above to add this skill to your agents.

Files (2)

Skill.md

903 B

---
name: osworld-version
type: python
description: "Get the API version information from the OSWorld server. Returns API version, server version, and protocol."
schema_hint:
  value: "ignored"
  out: "$variable"
examples:
  - '{"type":"osworld-version","out":"$version"}'
---

# OSWorld Version Tool (Level 4)

## Input
- No parameters required
- `value` parameter is ignored

## Output
- Note ID (bound to `out` variable) containing:
  - `text`: formatted version information
  - `metadata`: raw version data including:
    - `api_version`: API version string
    - `server_version`: server version string
    - `protocol`: protocol string (e.g., "http/json")

## Configuration
- `OSWORLD_URL` environment variable (defaults to `http://localhost:3002`)
- Or pass `osworld_url` in character config's `osworld_config` section

## Common Workflow
```json
{"type":"osworld-version","out":"$version"}
```

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.

FAQ

Does this skill require input parameters?

No. The skill does not accept parameters; any provided value is ignored.

How do I point the skill at a non-default server?

Set the OSWORLD_URL environment variable or include osworld_url under osworld_config in your character configuration.

What does the skill return?

It returns a note with text summarizing version info and metadata containing api_version, server_version, and protocol.