Skip to content

docs(readme): lead with what Runloop is and add package keywords - #836

Merged
james-rl merged 1 commit into
mainfrom
docs/sdk-discoverability-metadata
Sep 4, 2026
Merged

docs(readme): lead with what Runloop is and add package keywords#836
james-rl merged 1 commit into
mainfrom
docs/sdk-discoverability-metadata

Conversation

@james-rl

@james-rl james-rl commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

User description

Why

Coding agents pick a sandbox provider by searching, not from priors, so the metadata in this repo is part of the retrieval path. Today those signals are empty or generic:

  • package.json has no keywords and no homepage, and the description ("The official TypeScript library for the Runloop API") never says sandbox, AI agent, or code execution.
  • The README's first screen is a wall of base64-encoded MCP install badges, before it says what the package does.

What changed

package.json

  • Description leads with the category: "Official TypeScript SDK for Runloop — secure microVM sandboxes (devboxes) where AI agents run code, edit files, and expose ports."
  • Added keywords: runloop, sandbox, devbox, microvm, code-execution, code-interpreter, ai-agents, agent-runtime, agent-infrastructure, llm, typescript.
  • Added homepage pointing at docs.runloop.ai (was unset, so typedoc GitHub Pages was the effective landing spot) and a bugs URL.

README.md

  • Retitled "Runloop TypeScript SDK"; opens with a one-line category statement and five plain benefit bullets (long-lived devboxes with suspend()/resume(), full machine with filesystem/shell/background processes/public port URLs, blueprints and snapshots for fast repeat starts, SOC 2 and BYOC on AWS/GCP/Azure, built-in scenarios/scorers/benchmarks).
  • Moved the MCP badge section below the quickstart, so the first screen reads: what it is → npm install → working example.
  • The RunloopSDK-vs-.api note moved into Quickstart.

No source or behavior changes. prettier --check passes on both files.

Follow-ups (not in this PR)

  • Both files are Stainless-generated surfaces, so these values need mirroring into the Stainless config or the next generation reverts them.
  • GitHub repo description and topics are still empty — those are repo settings, not files.
  • The same changes apply to api-client-python.

🤖 Generated with Claude Code


CodeAnt-AI Description

Clarify the SDK’s sandbox offering and improve package discoverability

What Changed

  • The README now leads with Runloop’s secure microVM sandboxes for AI agents and summarizes their key capabilities, including persistent environments, full machine access, snapshots, cloud deployment, and evaluation tools.
  • Installation and quickstart guidance appears before the MCP Server setup, helping new users understand and try the SDK sooner.
  • Package metadata now identifies the SDK as a sandbox and agent platform, adds relevant search keywords, links to the documentation homepage, and provides the issue tracker.

Impact

✅ Clearer SDK purpose for AI agent developers
✅ Faster path from package discovery to first quickstart
✅ Easier npm search and documentation access

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Agents choosing a sandbox provider search rather than rely on priors, and
the signals they read here were empty or generic: no npm keywords, no
homepage, a description that never says "sandbox", and a README whose
first screen was MCP install badges.

- describe the package as microVM sandboxes for AI agents
- add npm keywords, homepage (docs.runloop.ai), and bugs URL
- open the README with the category plus plain benefit bullets
- move the MCP badges below the quickstart

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

Co-authored-by: Reflex <reflex@runloop.ai>
@codeant-ai

codeant-ai Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

🤖 CodeAnt AI — Review Status

Status Commit Started (UTC) Finished (UTC)
✅ Reviewed your PR a603960 Sep 04, 2026 · 01:08 01:09

@codeant-ai

codeant-ai Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@codeant-ai codeant-ai Bot added the size:M This PR changes 30-99 lines, ignoring generated files label Sep 4, 2026
@james-rl
james-rl requested review from dines-rl and tode-rl September 4, 2026 01:09
@james-rl
james-rl merged commit 51a7eab into main Sep 4, 2026
6 of 8 checks passed
@james-rl
james-rl deleted the docs/sdk-discoverability-metadata branch September 4, 2026 01:17
@tode-rl tode-rl mentioned this pull request Sep 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M This PR changes 30-99 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants