From a6039605ae442685b8165cf22e52d5f93ca8c7d8 Mon Sep 17 00:00:00 2001 From: james-rl Date: Fri, 4 Sep 2026 01:08:24 +0000 Subject: [PATCH] docs(readme): lead with what Runloop is and add package keywords 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 Co-authored-by: Reflex --- README.md | 30 ++++++++++++++++++------------ package.json | 17 ++++++++++++++++- 2 files changed, 34 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 809bddb8d..07bb3d1ac 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,16 @@ -# Runloop Node API Library +# Runloop TypeScript SDK [![NPM version](https://img.shields.io/npm/v/@runloop/api-client.svg)](https://npmjs.org/package/@runloop/api-client) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@runloop/api-client) -This library provides convenient access to the Runloop SDK & REST API from server-side TypeScript or JavaScript. +Official TypeScript SDK for [Runloop](https://docs.runloop.ai) — secure microVM sandboxes (**devboxes**) where AI agents run code, edit files, and expose ports. -The **RunloopSDK** is the recommended, modern way to interact with the Runloop API. It provides high-level object-oriented interfaces for common operations while maintaining full access to the underlying REST API through the `.api` property. +Why teams pick Runloop: -## MCP Server - -Use the Runloop MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application. - -[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40runloop%2Fapi-client-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBydW5sb29wL2FwaS1jbGllbnQtbWNwIl0sImVudiI6eyJSVU5MT09QX0FQSV9LRVkiOiJNeSBCZWFyZXIgVG9rZW4ifX0) -[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40runloop%2Fapi-client-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40runloop%2Fapi-client-mcp%22%5D%2C%22env%22%3A%7B%22RUNLOOP_API_KEY%22%3A%22My%20Bearer%20Token%22%7D%7D) - -> Note: You may need to set environment variables in your MCP client. +- **Sandboxes that live as long as your agent does.** Devboxes run for hours or days, and `suspend()` / `resume()` keeps the whole machine state between sessions. +- **A real machine, not just a code runner.** Full filesystem, shell, background processes, and public URLs for ports. +- **Fast repeat starts.** Blueprints and disk snapshots boot pre-built environments instead of reinstalling dependencies. +- **Built for production.** SOC 2 compliant, with bring-your-own-cloud deployment on AWS, GCP, and Azure. +- **Evaluation built in.** Scenarios, scorers, and benchmarks let you measure agent performance on the same platform you run it on. ## Installation @@ -23,7 +20,7 @@ npm install @runloop/api-client ## Quickstart -Here's a complete example that demonstrates the core SDK functionality: +`RunloopSDK` is the recommended way to use the API. It gives you high-level objects for common operations, and the full REST API stays available on `.api`. ```typescript import { RunloopSDK } from '@runloop/api-client'; @@ -58,6 +55,15 @@ console.log('Devbox logs:', logs.logs); await devbox.shutdown(); ``` +## MCP Server + +Use the Runloop MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application. + +[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40runloop%2Fapi-client-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBydW5sb29wL2FwaS1jbGllbnQtbWNwIl0sImVudiI6eyJSVU5MT09QX0FQSV9LRVkiOiJNeSBCZWFyZXIgVG9rZW4ifX0) +[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40runloop%2Fapi-client-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40runloop%2Fapi-client-mcp%22%5D%2C%22env%22%3A%7B%22RUNLOOP_API_KEY%22%3A%22My%20Bearer%20Token%22%7D%7D) + +> Note: You may need to set environment variables in your MCP client. + ## Examples Workflow-oriented runnable examples are documented in [`EXAMPLES.md`](./EXAMPLES.md). diff --git a/package.json b/package.json index d47e214f4..10604970a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,22 @@ { "name": "@runloop/api-client", "version": "1.31.0", - "description": "The official TypeScript library for the Runloop API", + "description": "Official TypeScript SDK for Runloop — secure microVM sandboxes (devboxes) where AI agents run code, edit files, and expose ports.", + "keywords": [ + "runloop", + "sandbox", + "devbox", + "microvm", + "code-execution", + "code-interpreter", + "ai-agents", + "agent-runtime", + "agent-infrastructure", + "llm", + "typescript" + ], + "homepage": "https://docs.runloop.ai", + "bugs": "https://github.com/runloopai/api-client-ts/issues", "author": "Runloop ", "types": "dist/sdk.d.ts", "main": "dist/sdk.js",