Skip to content

Commit 8ba7cbd

Browse files
Improve formatting of tool values in README (#37)
GitOrigin-RevId: 98bf7b3
1 parent 54d22db commit 8ba7cbd

1 file changed

Lines changed: 97 additions & 13 deletions

File tree

README.md

Lines changed: 97 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -168,14 +168,34 @@ Choose this method if no pre-compiled binary suits your system, you want to buil
168168
- **create_web_service** - Create a new web service in your Render account
169169

170170
- `name`: A unique name for your service (string, required)
171-
- `runtime`: Runtime environment for your service. Accepted values: 'node', 'python', 'go', 'rust', 'ruby', 'elixir', 'docker' (string, required)
171+
- `runtime`: Runtime environment for your service (string, required). Accepted values:
172+
- `node`
173+
- `python`
174+
- `go`
175+
- `rust`
176+
- `ruby`
177+
- `elixir`
178+
- `docker`
172179
- `buildCommand`: Command used to build your service (string, required)
173180
- `startCommand`: Command used to start your service (string, required)
174181
- `repo`: Repository containing source code (string, optional)
175182
- `branch`: Repository branch to deploy (string, optional)
176-
- `plan`: Plan for your service. Accepted values: 'starter', 'standard', 'pro', 'pro_max', 'pro_plus', 'pro_ultra' (string, optional)
177-
- `autoDeploy`: Whether to automatically deploy the service. Accepted values: 'yes', 'no'. Defaults to 'yes' (string, optional)
178-
- `region`: Geographic region for deployment. Accepted values: 'oregon', 'frankfurt', 'singapore', 'ohio', 'virginia'. Defaults to 'oregon' (string, optional)
183+
- `plan`: Plan for your service (string, optional). Accepted values:
184+
- `starter`
185+
- `standard`
186+
- `pro`
187+
- `pro_max`
188+
- `pro_plus`
189+
- `pro_ultra`
190+
- `autoDeploy`: Whether to automatically deploy the service (string, optional). Defaults to `yes`. Accepted values:
191+
- `yes`: Enable automatic deployments
192+
- `no`: Disable automatic deployments
193+
- `region`: Geographic region for deployment (string, optional). Defaults to `oregon`. Accepted values:
194+
- `oregon`
195+
- `frankfurt`
196+
- `singapore`
197+
- `ohio`
198+
- `virginia`
179199
- `envVars`: Environment variables array (array, optional)
180200

181201
- **create_static_site** - Create a new static site in your Render account
@@ -184,7 +204,9 @@ Choose this method if no pre-compiled binary suits your system, you want to buil
184204
- `buildCommand`: Command to build your app (string, required)
185205
- `repo`: Repository containing source code (string, optional)
186206
- `branch`: Repository branch to deploy (string, optional)
187-
- `autoDeploy`: Whether to automatically deploy the service. Accepted values: 'yes', 'no'. Defaults to 'yes' (string, optional)
207+
- `autoDeploy`: Whether to automatically deploy the service (string, optional). Defaults to `yes`. Accepted values:
208+
- `yes`: Enable automatic deployments
209+
- `no`: Disable automatic deployments
188210
- `publishPath`: Directory containing built assets (string, optional)
189211
- `envVars`: Environment variables array (array, optional)
190212

@@ -239,12 +261,28 @@ Choose this method if no pre-compiled binary suits your system, you want to buil
239261

240262
- **get_metrics** - Get performance metrics for any Render resource (services, Postgres databases, key-value stores). Metrics may be empty if the metric is not valid for the given resource
241263
- `resourceId`: The ID of the resource to get metrics for (service ID, Postgres ID, or key-value store ID) (string, required)
242-
- `metricTypes`: Which metrics to fetch (array of strings, required). Accepted values: 'cpu_usage', 'cpu_limit', 'cpu_target', 'memory_usage', 'memory_limit', 'memory_target', 'http_request_count', 'active_connections', 'instance_count', 'http_latency', 'bandwidth_usage'. CPU usage/limits/targets, memory usage/limits/targets, and instance count metrics are available for all resources. HTTP request counts and response time metrics, and bandwidth usage metrics are only available for services. Active connection metrics are only available for databases and key-value stores. Limits show resource constraints, targets show autoscaling thresholds
264+
- `metricTypes`: Which metrics to fetch (array of strings, required). Accepted values:
265+
- `cpu_usage`: CPU usage metrics (available for all resources)
266+
- `cpu_limit`: CPU resource constraints (available for all resources)
267+
- `cpu_target`: CPU autoscaling thresholds (available for all resources)
268+
- `memory_usage`: Memory usage metrics (available for all resources)
269+
- `memory_limit`: Memory resource constraints (available for all resources)
270+
- `memory_target`: Memory autoscaling thresholds (available for all resources)
271+
- `instance_count`: Instance count metrics (available for all resources)
272+
- `http_request_count`: HTTP request count metrics (services only)
273+
- `http_latency`: HTTP response time metrics (services only)
274+
- `bandwidth_usage`: Bandwidth usage metrics (services only)
275+
- `active_connections`: Active connection metrics (databases and key-value stores only)
243276
- `startTime`: Start time for metrics query in RFC3339 format (e.g., '2024-01-01T12:00:00Z'), defaults to 1 hour ago. The start time must be within the last 30 days (string, optional)
244277
- `endTime`: End time for metrics query in RFC3339 format (e.g., '2024-01-01T13:00:00Z'), defaults to the current time. The end time must be within the last 30 days (string, optional)
245278
- `resolution`: Time resolution for data points in seconds. Lower values provide more granular data. Higher values provide more aggregated data points. API defaults to 60 seconds if not provided, minimum 30 seconds (number, optional)
246-
- `cpuUsageAggregationMethod`: Method for aggregating CPU usage metric values over time intervals. Accepted values: 'AVG', 'MAX', 'MIN', defaults to 'AVG' (string, optional)
247-
- `aggregateHttpRequestCountsBy`: Field to aggregate HTTP request count metrics by. Accepted values: 'host' (aggregate by request host), 'statusCode' (aggregate by HTTP status code). When not specified, returns total request counts (string, optional)
279+
- `cpuUsageAggregationMethod`: Method for aggregating CPU usage metric values over time intervals (string, optional). Defaults to `AVG`. Accepted values:
280+
- `AVG`: Average CPU usage over time intervals
281+
- `MAX`: Maximum CPU usage over time intervals
282+
- `MIN`: Minimum CPU usage over time intervals
283+
- `aggregateHttpRequestCountsBy`: Field to aggregate HTTP request count metrics by (string, optional). When not specified, returns total request counts. Accepted values:
284+
- `host`: Aggregate by request host
285+
- `statusCode`: Aggregate by HTTP status code
248286
- `httpLatencyQuantile`: The quantile/percentile of HTTP latency to fetch. Only supported for http_latency metric. Common values: 0.5 (median), 0.95 (95th percentile), 0.99 (99th percentile). Defaults to 0.95 if not specified (number, optional, min: 0.0, max: 1.0)
249287
- `httpHost`: Filter HTTP metrics to specific request hosts. Supported for http_request_count and http_latency metrics. Example: 'api.example.com' or 'myapp.render.com'. When not specified, includes all hosts (string, optional)
250288
- `httpPath`: Filter HTTP metrics to specific request paths. Supported for http_request_count and http_latency metrics. Example: '/api/users' or '/health'. When not specified, includes all paths (string, optional)
@@ -266,8 +304,36 @@ Choose this method if no pre-compiled binary suits your system, you want to buil
266304

267305
- **create_postgres** - Create a new PostgreSQL database
268306
- `name`: Name of the PostgreSQL database (string, required)
269-
- `plan`: Pricing plan for the database. Accepted values: 'free', 'basic_256mb', 'basic_1gb', 'basic_4gb', 'pro_4gb', 'pro_8gb', 'pro_16gb', 'pro_32gb', 'pro_64gb', 'pro_128gb', 'pro_192gb', 'pro_256gb', 'pro_384gb', 'pro_512gb', 'accelerated_16gb', 'accelerated_32gb', 'accelerated_64gb', 'accelerated_128gb', 'accelerated_256gb', 'accelerated_384gb', 'accelerated_512gb', 'accelerated_768gb', 'accelerated_1024gb' (string, required)
270-
- `region`: Region for deployment. Accepted values: 'oregon', 'frankfurt', 'singapore', 'ohio', 'virginia' (string, optional)
307+
- `plan`: Pricing plan for the database (string, required). Accepted values:
308+
- `free`
309+
- `basic_256mb`
310+
- `basic_1gb`
311+
- `basic_4gb`
312+
- `pro_4gb`
313+
- `pro_8gb`
314+
- `pro_16gb`
315+
- `pro_32gb`
316+
- `pro_64gb`
317+
- `pro_128gb`
318+
- `pro_192gb`
319+
- `pro_256gb`
320+
- `pro_384gb`
321+
- `pro_512gb`
322+
- `accelerated_16gb`
323+
- `accelerated_32gb`
324+
- `accelerated_64gb`
325+
- `accelerated_128gb`
326+
- `accelerated_256gb`
327+
- `accelerated_384gb`
328+
- `accelerated_512gb`
329+
- `accelerated_768gb`
330+
- `accelerated_1024gb`
331+
- `region`: Region for deployment (string, optional). Accepted values:
332+
- `oregon`
333+
- `frankfurt`
334+
- `singapore`
335+
- `ohio`
336+
- `virginia`
271337
- `version`: PostgreSQL version to use (e.g., 14, 15) (number, optional)
272338
- `diskSizeGb`: Database capacity in GB (number, optional)
273339

@@ -283,9 +349,27 @@ Choose this method if no pre-compiled binary suits your system, you want to buil
283349

284350
- **create_key_value** - Create a new Key Value instance
285351
- `name`: Name of the Key Value instance (string, required)
286-
- `plan`: Pricing plan for the Key Value instance. Accepted values: 'free', 'starter', 'standard', 'pro', 'pro_plus' (string, required)
287-
- `region`: Region for deployment. Accepted values: 'oregon', 'frankfurt', 'singapore', 'ohio', 'virginia' (string, optional)
288-
- `maxmemoryPolicy`: Eviction policy for the Key Value store. Accepted values: 'noeviction', 'allkeys_lfu', 'allkeys_lru', 'allkeys_random', 'volatile_lfu', 'volatile_lru', 'volatile_random', 'volatile_ttl' (string, optional)
352+
- `plan`: Pricing plan for the Key Value instance (string, required). Accepted values:
353+
- `free`
354+
- `starter`
355+
- `standard`
356+
- `pro`
357+
- `pro_plus`
358+
- `region`: Region for deployment (string, optional). Accepted values:
359+
- `oregon`
360+
- `frankfurt`
361+
- `singapore`
362+
- `ohio`
363+
- `virginia`
364+
- `maxmemoryPolicy`: Eviction policy for the Key Value store (string, optional). Accepted values:
365+
- `noeviction`: No eviction policy (may cause memory errors)
366+
- `allkeys_lfu`: Evict least frequently used keys from all keys
367+
- `allkeys_lru`: Evict least recently used keys from all keys
368+
- `allkeys_random`: Evict random keys from all keys
369+
- `volatile_lfu`: Evict least frequently used keys from keys with expiration
370+
- `volatile_lru`: Evict least recently used keys from keys with expiration
371+
- `volatile_random`: Evict random keys from keys with expiration
372+
- `volatile_ttl`: Evict keys with shortest time to live from keys with expiration
289373

290374
## Example Interactions
291375

0 commit comments

Comments
 (0)