skills.rest
yuezhen-huang
yuezhen-huangCOMMUNITY
Explore all skills by this author →
GitHub

bytecloud-doc

Search ByteCloud Document Center and retrieve full document content by doc_id.

Updated Apr 30, 2026
Search Tags:#documentation#knowledge search#gdpa-cli#bytecloud#tce#doc retrieval#cloud.bytedance.net
One-click install
npx skills add https://github.com/yuezhen-huang/my-bytedance-skillhub --skill bytecloud-doc-yuezhen-huang
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bytecloud-doc
Source: https://github.com/yuezhen-huang/my-bytedance-skillhub/tree/main/bytecloud-doc
Command: npx skills add https://github.com/yuezhen-huang/my-bytedance-skillhub --skill bytecloud-doc-yuezhen-huang

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Engineers often need to find ByteCloud platform documentation (TCE, TCC, Neptune, BITS) but lack a direct way to search the ByteCloud Document Center knowledge base and read full articles programmatically. This Skill provides knowledge base search and full document retrieval through the ByteCloud web API endpoints. ## Core Features & Use Cases - Knowledge Search: Query the ByteCloud Document Center with natural language, optionally filtering by product IDs (e.g., tce, bits) or excluding products. - Full Document Retrieval: Fetch complete document bodies by doc_id, including Markdown content, HTML, breadcrumbs, and metadata. - Multi-Environment Support: Target either the CN production site (cloud.bytedance.net) or the BOE environment (cloud-boe.bytedance.net) via site aliases or a custom target address. - Use Case: When troubleshooting a TCE scaling issue, search for "tce如何扩容", review the ranked results, then pull the full guide by doc_id to follow the steps. ## Quick Start Ask the agent to search ByteCloud documentation for how to expand capacity on TCE and then fetch the full document for the top result.

Frequently Asked Questions about bytecloud-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I search ByteCloud documentation from the command line?▼

Run gdpa-cli with the bytecloud-doc agent using the knowledge_search action and a natural language query. The result returns ranked items with title, URL, content snippet, score, and doc_id for follow-up retrieval.

How do I get the full content of a ByteCloud document by doc_id?▼

Use the get_document action with the doc_id obtained from a knowledge_search result or from the document URL path. The response includes Markdown content, HTML, breadcrumbs, and metadata such as publisher and update time.

Can I search ByteCloud docs in the BOE environment?▼

Yes, set the site field to boe or pass a target_addr pointing to cloud-boe.bytedance.net. By default the environment is auto-detected, using the BOE site when running in BOE and the production site otherwise.

How do I filter ByteCloud doc search results by product?▼

Pass product_ids as a string array, such as tce or bits, to restrict results to those products. You can also use ignore_product_ids to exclude specific products from the search results.

Why does ByteCloud doc search fail with an authentication error?▼

The agent automatically obtains a CN JWT internally, but if that fails you must run gdpa-cli login cn first. You can also override authentication by passing a jwt or token field in the input JSON.

Related Skills

Explore More Software Engineering Skills→
AJV009AJV009
1

drupal-docs-explorer

Fetch official Drupal documentation from drupal.org and api.drupal.org.

Community
Intermediate
gjallagjalla
1

write-runbook

Create operational runbooks with sections for alerts, troubleshooting, and rollback.

Official
Advanced
wojonswojons
4

observability-logging

Integrate logs with metrics, traces, alerts, and dashboards for system observability.

Community
Advanced
zephyrwang6zephyrwang6
14

lark-wiki

Manage Lark wiki spaces, nodes, and document organization via lark-cli.

Community
Intermediate