volcengine-sdk-generator

Files (7)

• LICENSE
• SKILL.md
• sdk-integration-go.md · references/
• sdk-integration-java.md · references/
• sdk-integration-nodejs.md · references/
• sdk-integration-php.md · references/
• sdk-integration-python.md · references/

SKILL.md (first lines)

# Volcengine SDK Code Generator

Generate complete, runnable Volcengine SDK code from natural-language descriptions, and answer SDK configuration questions.

## Workflow

When a user describes a Volcengine API operation, follow these steps:

### Step 1: Identify Target Service, Operation, and Advanced Configuration Needs

Parse the user's description to determine:
- **Target service**: which Volcengine service (e.g., ECS, VPC, TOS, billing)
- **Target operation**: what operation to perform (e.g., list instances, create a VPC, query billing)
- **Target language**: which programming language (Go, Python, PHP, Java, Node.js). If not specified, ask the user.
- **Advanced configuration needs**: whether the user mentions or the scenario implies any of the following:
  - **Retry**: user mentions "retry", "fault tolerance", or the operation is a write/create type (prone to throttling)
  - **Timeout**: user mentions "timeout", or the operation involves large data volumes (batch queries, file uploads)
  - **Credentials**: user mentions "STS", "AssumeRole", "temporary credentials", "OIDC", or explicitly wants to avoid hardcoding AK/SK
  - **Proxy/network**: user mentions "proxy" or "internal network"
  - **Debug mode**: user mentions "debug" or "logging"
  - **Connection pooling**: user mentions "connection pool", "high concurrency", or "pool"

  If the user explicitly requests these, include the corresponding configuration in the generated code. If not explicitly requested but implied by the scenario (e.g., resource creation naturally warrants retry), include suggested configuration as comments.

### Step 2: Query Service Metadata via Volcengine API Explorer

Use the following APIs to find the correct service code, version, and action name. This step is critical because guessing often produces incorrect code — the API Explorer is the authoritative source.

**2a. Find the ServiceCode**

Fetch the service catalog:
```
GET https://api.volcengine.com/api/common/explorer/services
```
Response structure:
```json
{
  "Result": {
    "Categories": [
      {
        "CategoryName": "...",
        "Services": [
          {
            "ServiceCn": "Cloud Server",
            "ServiceCode": "ecs",
            "Product": "ECS",
            "IsSdkAvailable": true,
            "RegionType": "regional"
          }
        ]
      }
    ]
  }
}
```
Match the user's intent to the correct `ServiceCode` based on `ServiceCn`, `Product`, and category name.

**2b. Find the API version**

```
GET https://api.volcengine.com/api/common/explorer/versions?ServiceCode={ServiceCode}
```
Response:
```json
{
  "Result": {
    "Versions": [
      {
        "ServiceCode": "billing",
        "Version": "2022-01-01",
        "IsDefault": 0
      }
    ]
  }
}
```
Use the version with `IsDefault == 1`. If no default version exists, use the latest available.

**2c. Find the Action name**

```
GET https://api.volcengine.com/api/common/explorer/apis?ServiceCode={ServiceCode}&Version={Version}&APIVersion={Version}
```
Response:
```json
{
  "Result": {
    "Groups": [
      {
        "Name": "Instance",
        "Apis": [
          {
            "Action": "DescribeInstances",
            "NameCn": "Query instance list",
            "Description": "..."
          }
        ]
      }
    ]
  }
}
```
Match user intent using the `Action` name and `NameCn` (Chinese name).

**2c-alt: Search API (when direct lookup fails)**

If the service catalog or API list cannot clearly match the user's description — for example, the user uses vague terms, Chinese names that don't map directly to a ServiceCode, or the API list doesn't seem to contain what the user wants — use the search API as a fallback:

```
GET https://api.volcengine.com/api/common/search/all?Query={URL-encoded search term}&Channel=api&Limit=10
```

Search terms can be Chinese or English — use whichever best matches the user's description.

Response structure:
```json
{
  "Result": {
    "List": [

From bytedance/agentkit-samples, Apache-2.0.

More from bytedance/agentkit-samples