@doubao-dev/cli 1.0.0-rc.0 → 1.0.0-rc.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -5
- package/bin/run.js +1 -6
- package/dist/691.js +96 -0
- package/dist/691.js.LICENSE.txt +13 -0
- package/dist/build.js +1 -0
- package/dist/categories.js +1 -1
- package/dist/command.js +9 -2
- package/dist/command~1.js +4 -4
- package/dist/command~2.js +1 -1
- package/dist/command~3.js +2 -1
- package/dist/command~4.js +1 -1
- package/dist/command~5.js +6 -2
- package/dist/dist.js +1 -1
- package/dist/draft.js +2 -2
- package/dist/index.d.ts +892 -11
- package/dist/index.js +1 -1
- package/dist/main.d.ts +892 -11
- package/dist/main.js +1 -1
- package/dist/mcp-apps-inspector.js +1 -0
- package/dist/multipart-parser.js +2 -0
- package/dist/open.js +2 -0
- package/dist/plugin.js +3 -1
- package/dist/plugin.js.LICENSE.txt +58 -0
- package/dist/preview.js +9 -0
- package/dist/progress.js +1 -0
- package/dist/ratatui-ui.js +1 -1
- package/dist/rslib-runtime.js +1 -0
- package/dist/session.js +2 -1
- package/dist/session.js.LICENSE.txt +1 -0
- package/dist/skills/doubao-plugin-cli/SKILL.md +44 -40
- package/dist/skills/doubao-plugin-cli/references/cli/development.md +126 -0
- package/dist/skills/doubao-plugin-cli/references/cli/project.md +188 -0
- package/dist/skills/doubao-plugin-cli/references/cli/release.md +144 -0
- package/dist/skills/doubao-plugin-cli/references/examples/todo-example.md +88 -0
- package/dist/skills/doubao-plugin-cli/references/examples/workbench-example.md +130 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/business-skills.md +49 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/cli-connectors.md +56 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/managed-agents.md +46 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/mcp-apps/integration.md +186 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/mcp-apps/runtime.md +318 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/mcp-apps/workbench.md +180 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/mcp-auth.md +73 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/mcp-config.md +145 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/mcp-events.md +260 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/plugin-json.md +95 -0
- package/dist/skills/doubao-plugin-cli/references/protocols/workbench.md +120 -0
- package/dist/skills/doubao-plugin-cli/references/upstream/SOURCES.md +24 -0
- package/dist/skills/doubao-plugin-cli/references/upstream/mcp-apps.LICENSE +216 -0
- package/dist/skills/doubao-plugin-cli/references/upstream/mcp-apps.mdx +1768 -0
- package/dist/skills/doubao-plugin-cli/references/upstream/mcp-events.LICENSE +216 -0
- package/dist/skills/doubao-plugin-cli/references/upstream/mcp-events.md +1231 -0
- package/dist/skills/doubao-plugin-cli/references/upstream/standard-webhooks.LICENSE +201 -0
- package/dist/skills/doubao-plugin-cli/references/upstream/standard-webhooks.md +349 -0
- package/dist/templates/standard/AGENTS.md +1 -1
- package/dist/templates/workbench/README.md.template +9 -0
- package/dist/templates/workbench/com.doubao/workbench/manifest.json +10 -0
- package/dist/uninstall.js +1 -1
- package/dist/versions.js +1 -1
- package/dist/versions~1.js +1 -0
- package/dist/web/index.html +1 -0
- package/dist/web/sandbox-proxy.html +101 -0
- package/dist/web/static/css/index.b3102f16b9.css +1 -0
- package/dist/web/static/js/155.747f5232dc.js +69 -0
- package/dist/web/static/js/async/970.86106314b5.js +1 -0
- package/dist/web/static/js/index.c1186260b9.js +4 -0
- package/dist/web/static/js/lib-react.00514652bf.js +2 -0
- package/dist/web/static/js/lib-react.00514652bf.js.LICENSE.txt +39 -0
- package/dist/workbench-search.js +1 -0
- package/dist/xdg-open +1267 -0
- package/package.json +17 -16
- package/dist/472.js +0 -9
- package/dist/schema.js +0 -1
- package/dist/skills/doubao-plugin-cli/references/cli-connectors.md +0 -29
- package/dist/skills/doubao-plugin-cli/references/development.md +0 -29
- package/dist/skills/doubao-plugin-cli/references/mcp-apps.md +0 -40
- package/dist/skills/doubao-plugin-cli/references/mcp-auth.md +0 -23
- package/dist/skills/doubao-plugin-cli/references/project-config.md +0 -139
- package/dist/skills/doubao-plugin-cli/references/upload.md +0 -71
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@doubao-dev/cli",
|
|
3
|
-
"version": "1.0.0-rc.
|
|
3
|
+
"version": "1.0.0-rc.11",
|
|
4
4
|
"description": "Doubao Plugins CLI",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -21,27 +21,30 @@
|
|
|
21
21
|
"!dist/**/*.map"
|
|
22
22
|
],
|
|
23
23
|
"dependencies": {
|
|
24
|
+
"commander": "15.0.0",
|
|
25
|
+
"zod": "4.2.0"
|
|
26
|
+
},
|
|
27
|
+
"devDependencies": {
|
|
28
|
+
"@byted-doubao-apps/build-shared": "0.10.0",
|
|
24
29
|
"@clack/prompts": "0.11.0",
|
|
25
|
-
"
|
|
30
|
+
"@net-fe/cdn-upload-server": "0.1.8",
|
|
26
31
|
"chalk": "5.6.2",
|
|
27
32
|
"chokidar": "5.0.0",
|
|
28
|
-
"
|
|
33
|
+
"execa": "9.6.0",
|
|
29
34
|
"fs-extra": "11.3.5",
|
|
35
|
+
"mcp-apps-inspector": "0.1.0",
|
|
30
36
|
"ofetch": "1.5.1",
|
|
31
37
|
"open": "10.1.0",
|
|
32
38
|
"ora": "8.1.0",
|
|
33
|
-
"
|
|
34
|
-
|
|
35
|
-
|
|
39
|
+
"@byted-doubao-apps/cli": "1.0.0-rc.11",
|
|
40
|
+
"@doubao-dev/kit": "0.10.0",
|
|
41
|
+
"@doubao-dev/plugin-app-dev": "1.0.0-rc.11",
|
|
36
42
|
"@rslib/core": "1.0.0-beta.1",
|
|
37
43
|
"@types/node": "22.20.4",
|
|
44
|
+
"@types/qrcode": "1.5.6",
|
|
45
|
+
"qrcode": "1.5.4",
|
|
38
46
|
"rimraf": "3.0.2",
|
|
39
47
|
"typescript": "6.0.3",
|
|
40
|
-
"@byted-doubao-apps/build-shared": "0.8.0",
|
|
41
|
-
"@byted-doubao-apps/cli": "1.0.0-rc.0",
|
|
42
|
-
"@doubao-dev/plugin-app-dev": "1.0.0-rc.0",
|
|
43
|
-
"@doubao-dev/kit": "0.8.0",
|
|
44
|
-
"@doubao-dev/plugin-mcp-inspector": "1.0.0-rc.0",
|
|
45
48
|
"@byted-doubao-apps/cli-ratatui": "0.4.0"
|
|
46
49
|
},
|
|
47
50
|
"engines": {
|
|
@@ -49,13 +52,11 @@
|
|
|
49
52
|
},
|
|
50
53
|
"publishConfig": {
|
|
51
54
|
"access": "public",
|
|
55
|
+
"executableFiles": [
|
|
56
|
+
"dist/xdg-open"
|
|
57
|
+
],
|
|
52
58
|
"registry": "https://registry.npmjs.org"
|
|
53
59
|
},
|
|
54
|
-
"optionalDependencies": {
|
|
55
|
-
"@doubao-dev/cli-tui-darwin-arm64": "1.0.0-rc.0",
|
|
56
|
-
"@doubao-dev/cli-tui-darwin-x64": "1.0.0-rc.0",
|
|
57
|
-
"@doubao-dev/cli-tui-win32-x64": "1.0.0-rc.0"
|
|
58
|
-
},
|
|
59
60
|
"scripts": {
|
|
60
61
|
"build": "rimraf dist && rslib build",
|
|
61
62
|
"clean": "rimraf dist"
|
package/dist/472.js
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import{Command as e,CommanderError as t,Option as r}from"commander";import a from"node:assert/strict";import{execFile as o,spawn as i}from"node:child_process";import n,{randomUUID as s}from"node:crypto";import{once as c}from"node:events";import l,{basename as u,dirname as p,join as d,resolve as f}from"node:path";import{isCancel as h,log as m,select as w}from"@clack/prompts";import{z as g}from"zod";import y,{homedir as v}from"node:os";import _,{promises as b}from"node:fs";import{promisify as S,stripVTControlCharacters as k}from"node:util";import{setTimeout as E}from"node:timers/promises";import{ofetch as T}from"ofetch";import{oraPromise as A}from"ora";import{createRequire as $}from"node:module";import{pathToFileURL as P}from"node:url";import*as x from"node:fs";function O(e){return e instanceof Error?e.message:String(e)}async function U(e){let t=new Set;for(let{name:r}of e)a(r.trim()&&!t.has(r),`插件名称为空或重复:${r}`),t.add(r);let o={setup:[],initOptions:[],prepareTemplates:[],afterCreate:[],provideSkills:[],exclude:[],uploadSuccess:[],devTargets:[]};for(let t of e)try{await t.setup(function(e,t){return{cli:{onSetup:r=>t.setup.push({pluginName:e,callback:r})},init:{addOption:e=>t.initOptions.push(e),onPrepareTemplates:r=>t.prepareTemplates.push({pluginName:e,callback:r}),onAfterCreate:r=>t.afterCreate.push({pluginName:e,callback:r})},skills:{onProvide:r=>t.provideSkills.push({pluginName:e,callback:r})},package:{onExclude:r=>t.exclude.push({pluginName:e,callback:r})},upload:{onSuccess:r=>t.uploadSuccess.push({pluginName:e,callback:r})},dev:{addTarget:o=>{a(o.name.trim()&&!t.devTargets.some(e=>e.target.name===o.name),`开发目标名称为空或重复:${o.name}`);let i=o.option&&new r(o.option.flags).attributeName();t.devTargets.push({pluginName:e,target:o,attribute:i})}}}}(t.name,o))}catch(e){throw Error(`[${t.name}] 注册失败:${O(e)}`,{cause:e})}return o}async function N(e,t){let r=await U(t);for(let t of r.setup)await C(t,{program:e,hooks:r})}async function C({pluginName:e,callback:t},...r){try{return await t(...r)}catch(t){throw Error(`[${e}] ${O(t)}`,{cause:t})}}async function I(e,...t){let r=[];for(let a of e)r.push(...await C(a,...t));return r}var D,L,F=JSON.parse('{"UU":"@doubao-dev/cli","rE":"1.0.0-rc.0","h_":"Doubao Plugins CLI"}');let R={name:F.UU,version:F.rE,description:F.h_,registry:"https://registry.npmjs.org",appDev:{name:"@doubao-dev/plugin-app-dev",version:F.rE},mcpInspector:{name:"@doubao-dev/plugin-mcp-inspector",version:F.rE,title:"MCP 调试工具"},kit:{name:"@doubao-dev/kit",version:process.env.DBX_KIT_VERSION?.trim()||"0.8.0"},auth:{baseUrl:"https://open.doubao.com",verificationUrl:"https://open.doubao.com/apps-plugin/oauth/device"},apiUrl:"https://open.doubao.com",apiHeaders:{"User-Agent":`doubao-dev-cli-${F.rE}`},deviceApiUrl:"https://developer.doubao.com",consoleUrl:"https://open.doubao.com/console/plugins/create"},H=l.join(y.homedir(),".dbx","token"),j=l.join(y.homedir(),".doubao","token"),M={};function K(e={}){let t={...M,...e},r=J(t.baseUrl??"https://developer.doubao.com","baseUrl"),a=t.tokenPath??H;return{...t,baseUrl:r,verificationUrl:J(t.verificationUrl??new URL("/oauth/device",r).href,"verificationUrl"),allowedOrigins:function(e,t){let r=new Set([new URL(t).origin]);for(let t of e??[]){let e;try{e=new URL(t)}catch{throw Error(`allowedOrigins 中的来源必须是完整的 HTTPS 地址:${t}`)}if("https:"!==e.protocol)throw Error(`allowedOrigins 中的来源必须使用 HTTPS:${t}`);r.add(e.origin)}return[...r]}(t.allowedOrigins,r),tokenPath:a,legacyTokenPath:t.tokenPath?void 0:j,requestHeaders:new Headers(t.requestHeaders)}}function B(e){return e.replace(/\/+$/,"")}function J(e,t){let r;try{r=new URL(B(e))}catch{throw Error(`${t} 必须是完整的 HTTPS URL`)}if("https:"!==r.protocol)throw Error(`${t} 必须使用 HTTPS`);return B(r.toString())}let q=S(o),V="byted-doubao-open-dbx-cli",X="dbx-cli",G="aes-256-gcm";class z extends Error{constructor(e){super(e),this.name="CredentialStoreError"}}class Y extends z{constructor(){super("无法读取本地登录凭证:用于解密凭证的密钥文件 master.key 已丢失。请运行 dbx auth login 重新登录。")}}class W{constructor(e,t){this.primary=e,this.fallback=t}async get(e){let t;if(await this.isFallbackAuthoritative(e))return this.fallback.get(e);try{let t=await this.primary.get(e);if(t)return t}catch(e){t=e}try{let t=await this.fallback.get(e);if(t)return t}catch(e){if(t)throw new z(`从系统凭证存储读取登录凭证失败(${el(t)});从备用加密文件读取也失败:${el(e)}`);throw e}if(t)throw t instanceof Error?t:new z(`从系统凭证存储读取登录凭证失败:${String(t)}`)}async set(e,t){let r;try{await this.primary.set(e,t)}catch(e){r=e}try{await this.fallback.set(e,t)}catch(t){if(r)throw new z(`向系统凭证存储写入登录凭证失败(${el(r)}),写入备用加密文件也失败(${el(t)})`);throw await this.removeStaleFallbackAfterPrimaryWrite(e,t),t}r?await this.markFallbackAuthoritative(e):await this.clearFallbackAuthority(e)}async delete(e){let t;try{await this.primary.delete(e)}catch(e){t=e}try{await this.fallback.delete(e)}catch(e){if(t)throw new z(`从系统凭证存储删除登录凭证失败(${el(t)}),从备用加密文件删除也失败(${el(e)})`);throw e}t?await this.markFallbackAuthoritativeOrThrow(e,t):await this.clearFallbackAuthority(e)}async isFallbackAuthoritative(e){return!!ea(this.fallback)&&this.fallback.isFallbackAuthoritative(e)}async markFallbackAuthoritative(e){ea(this.fallback)&&await this.fallback.markFallbackAuthoritative(e)}async markFallbackAuthoritativeOrThrow(e,t){if(!ea(this.fallback))throw t instanceof Error?t:new z(`系统凭证删除失败,且备用存储无法记录删除状态:${String(t)}`);try{await this.fallback.markFallbackAuthoritative(e)}catch(e){throw new z(`系统凭证删除失败(${el(t)}),且无法记录备用凭证删除状态:${el(e)}`)}}async clearFallbackAuthority(e){ea(this.fallback)&&await this.fallback.clearFallbackAuthority(e)}async removeStaleFallbackAfterPrimaryWrite(e,t){let r=[];try{await this.fallback.delete(e)}catch(e){r.push(e)}try{await this.clearFallbackAuthority(e)}catch(e){r.push(e)}if(r.length>0)throw new z(`系统凭证已写入,但备用加密文件写入失败(${el(t)}),且清理旧备用凭证失败:${r.map(el).join(";")}`)}}class Q{constructor(e={}){this.baseDir=e.baseDir??("darwin"===process.platform?l.join(y.homedir(),"Library","Application Support",X):"win32"===process.platform?l.join(process.env.APPDATA||l.join(y.homedir(),"AppData","Roaming"),X):l.join(process.env.XDG_DATA_HOME||l.join(y.homedir(),".local","share"),X))}async get(e){var t,r;let a,o,i=this.credentialFilePath(e);try{a=await b.readFile(i,"utf8")}catch(e){if(ec(e)&&"ENOENT"===e.code)return;throw new z(`读取加密凭证文件失败:${el(e)}`)}try{o=JSON.parse(a)}catch(e){throw new z(`加密凭证文件不是有效的 JSON:${el(e)}`)}if(!((t=o)&&"object"==typeof t&&1===t.version&&t.algorithm===G&&"string"==typeof t.iv&&"string"==typeof t.authTag&&"string"==typeof t.ciphertext))throw new z("无法读取本地登录凭证:当前 CLI 不支持凭证文件中的格式或字段。");let s=await this.readMasterKey();try{let t=n.createDecipheriv(G,s,Buffer.from(o.iv,"base64url"));return t.setAAD(Buffer.from((r=e,`${V}:${r}`),"utf8")),t.setAuthTag(Buffer.from(o.authTag,"base64url")),Buffer.concat([t.update(Buffer.from(o.ciphertext,"base64url")),t.final()]).toString("utf8")}catch(e){throw new z(`解密凭证文件失败:${el(e)}`)}}async set(e,t){var r;let a=await this.readOrCreateMasterKey(),o=n.randomBytes(12),i=n.createCipheriv(G,a,o);i.setAAD(Buffer.from((r=e,`${V}:${r}`),"utf8"));let s=Buffer.concat([i.update(t,"utf8"),i.final()]),c={version:1,algorithm:G,iv:o.toString("base64url"),authTag:i.getAuthTag().toString("base64url"),ciphertext:s.toString("base64url")};await et(this.credentialFilePath(e),`${JSON.stringify(c,null,2)}
|
|
2
|
-
`)}async delete(e){try{await b.unlink(this.credentialFilePath(e))}catch(e){if(!ec(e)||"ENOENT"!==e.code)throw new z(`删除加密凭证文件失败:${el(e)}`)}}async isFallbackAuthoritative(e){try{let t=await b.readFile(this.authorityFilePath(e),"utf8"),r=JSON.parse(t);return 1===r.version&&"fallback"===r.authority}catch(e){if(ec(e)&&"ENOENT"===e.code)return!1;throw new z(`读取登录凭证权威副本标记失败:${el(e)}`)}}async markFallbackAuthoritative(e){await et(this.authorityFilePath(e),`${JSON.stringify({version:1,authority:"fallback"},null,2)}
|
|
3
|
-
`)}async clearFallbackAuthority(e){try{await b.unlink(this.authorityFilePath(e))}catch(e){if(!ec(e)||"ENOENT"!==e.code)throw new z(`清理登录凭证权威副本标记失败:${el(e)}`)}}masterKeyPath(){return l.join(this.baseDir,"master.key")}credentialFilePath(e){let t=n.createHash("sha256").update(e).digest("hex");return l.join(this.baseDir,"credentials",`${t}.json`)}authorityFilePath(e){let t=n.createHash("sha256").update(e).digest("hex");return l.join(this.baseDir,"authorities",`${t}.json`)}async readMasterKey(){try{var e=await b.readFile(this.masterKeyPath(),"utf8");let t=Buffer.from(e.trim(),"base64url");if(32!==t.length)throw new z("无法读取本地登录凭证:密钥文件 master.key 的内容无法解析为 32 字节密钥。");return t}catch(e){if(ec(e)&&"ENOENT"===e.code)throw new Y;if(e instanceof z)throw e;throw new z(`无法读取用于解密本地登录凭证的密钥文件 master.key:${el(e)}`)}}async readOrCreateMasterKey(){try{return await this.readMasterKey()}catch(e){if(!(e instanceof Y))throw e}let e=n.randomBytes(32);try{return await er(this.masterKeyPath(),`${e.toString("base64url")}
|
|
4
|
-
`)?e:this.readMasterKey()}catch(e){throw new z(`无法保存用于加密本地登录凭证的密钥文件 master.key:${el(e)}`)}}}class Z{async get(e){try{let{stdout:t}=await q("security",["find-generic-password","-a",e,"-s",V,"-w"]);return String(t).replace(/\n$/,"")}catch(e){if(eo(e))return;throw new z(`从 macOS 钥匙串读取登录凭证失败:${el(e)}`)}}async set(e,t){try{await q("security",["add-generic-password","-a",e,"-s",V,"-w",t,"-U"])}catch(e){throw new z(`向 macOS 钥匙串写入登录凭证失败:${el(e)}`)}}async delete(e){try{await q("security",["delete-generic-password","-a",e,"-s",V])}catch(e){if(eo(e))return;throw new z(`从 macOS 钥匙串删除登录凭证失败:${el(e)}`)}}}class ee{async get(e){try{let{stdout:t}=await q("secret-tool",["lookup","service",V,"account",e]);return String(t).replace(/\n$/,"")}catch(e){if(ei(e))return;throw new z(`从 Secret Service 读取登录凭证失败:${el(e)}`)}}async set(e,t){try{var r,a,o;await (r="secret-tool",a=["store","--label","Doubao Open CLI 登录凭证","service",V,"account",e],o=t,new Promise((e,t)=>{let n=i(r,a,{stdio:["pipe","ignore","pipe"]}),s="";n.stderr.setEncoding("utf8"),n.stderr.on("data",e=>{s+=String(e)}),n.on("error",t),n.on("close",a=>{0===a?e():t(Error(s.trim()||`${r} 已退出,退出码为 ${a}`))}),n.stdin.end(o)}))}catch(e){throw new z(`向 Secret Service 写入登录凭证失败:${el(e)}`)}}async delete(e){try{await q("secret-tool",["clear","service",V,"account",e])}catch(e){if(ei(e))return;throw new z(`从 Secret Service 删除登录凭证失败:${el(e)}`)}}}async function et(e,t){let r=l.dirname(e);await b.mkdir(r,{recursive:!0,mode:448}),"win32"!==process.platform&&await b.chmod(r,448);let a=l.join(r,`.${l.basename(e)}.${process.pid}.${Date.now()}.tmp`);try{await b.writeFile(a,t,{mode:384,flag:"wx"}),"win32"!==process.platform&&await b.chmod(a,384),await b.rename(a,e),"win32"!==process.platform&&await b.chmod(e,384)}finally{try{await b.unlink(a)}catch{}}}async function er(e,t){let r=l.dirname(e);await b.mkdir(r,{recursive:!0,mode:448}),"win32"!==process.platform&&await b.chmod(r,448);let a=l.join(r,`.${l.basename(e)}.${process.pid}.${Date.now()}.${n.randomBytes(8).toString("hex")}.tmp`);try{await b.writeFile(a,t,{mode:384,flag:"wx"}),"win32"!==process.platform&&await b.chmod(a,384);try{return await b.link(a,e),"win32"!==process.platform&&await b.chmod(e,384),!0}catch(e){if(ec(e)&&"EEXIST"===e.code)return!1;throw e}}finally{try{await b.unlink(a)}catch{}}}function ea(e){return"function"==typeof e.isFallbackAuthoritative&&"function"==typeof e.markFallbackAuthoritative&&"function"==typeof e.clearFallbackAuthority}function eo(e){let t=en(e),r=es(e);return(1===t||44===t)&&(r.includes("could not be found")||r.includes("The specified item could not be found"))}function ei(e){let t=en(e),r=es(e);return 1===t&&(r.includes("could not be found")||r.includes("No matching items")||""===r.trim())}function en(e){return"object"==typeof e&&null!==e&&"code"in e?e.code:void 0}function es(e){return"object"==typeof e&&null!==e&&"stderr"in e?String(e.stderr??""):""}function ec(e){return e instanceof Error&&"code"in e}function el(e){if("object"==typeof e&&null!==e&&"stderr"in e){let t=String(e.stderr??"").trim();if(t)return t}return e instanceof Error&&e.message?e.message:String(e)}class eu extends Error{constructor(e,t){super(e),this.code=t,this.name="AuthError"}}class ep extends eu{constructor(e="尚未登录,请运行 dbx auth login 完成登录。"){super(e,"NOT_LOGGED_IN"),this.name="NotLoggedInError"}}class ed extends eu{constructor(e="登录凭证已过期,请运行 dbx auth login 重新登录。"){super(e,"TOKEN_EXPIRED"),this.name="TokenExpiredError"}}class ef extends eu{constructor(e,t="DEVICE_AUTH_FAILED",r={}){super(e,t),this.name="DeviceAuthError",this.logId=r.logId}}async function eh(e,t={}){let r,a=process.env.DBX_ACCESS_TOKEN?.trim()||void 0;if(a)return{accessToken:a,tokenType:"Bearer",expiresAt:0xf4865700,baseUrl:t.envTokenBaseUrl??""};let o=await e_(e);if(void 0===o)return eb(e,t);try{r=JSON.parse(o)}catch(e){return}if(ev(r)){if(!t.allowExpired&&eg(r))return void await ew(e,t);let a=await eS(t).get(r.credentialAccount);if(!a)throw new z("已找到登录记录,但登录凭证缺失或无法访问。请在能够访问凭证存储的终端中重新运行 dbx auth login。");return{accessToken:a,tokenType:r.tokenType,expiresAt:r.expiresAt,baseUrl:r.baseUrl}}if(ey(r))return!t.allowExpired&&eg(r)?void await ew(e,t):(await em(e,r,t),r)}async function em(e,t,r={}){let a={version:2,storage:"keychain",credentialAccount:ek(e),tokenType:t.tokenType,expiresAt:t.expiresAt,baseUrl:t.baseUrl};await eS(r).set(a.credentialAccount,t.accessToken),await b.mkdir(l.dirname(e),{recursive:!0,mode:448}),"win32"!==process.platform&&await b.chmod(l.dirname(e),448);let o=`${e}.${process.pid}.${Date.now()}.tmp`;await b.writeFile(o,`${JSON.stringify(a,null,2)}
|
|
5
|
-
`,{mode:384}),"win32"!==process.platform&&await b.chmod(o,384),await b.rename(o,e),"win32"!==process.platform&&await b.chmod(e,384)}async function ew(e,t={}){let r=await e_(e),a=ek(e);if(void 0!==r)try{let e=JSON.parse(r);ev(e)&&(a=e.credentialAccount)}catch{}await eS(t).delete(a);try{await b.unlink(e)}catch(e){if(!eE(e)||"ENOENT"!==e.code)throw e}}function eg(e,t=Math.floor(Date.now()/1e3)){return e.expiresAt<=t}function ey(e){return!!e&&"object"==typeof e&&"string"==typeof e.accessToken&&e.accessToken.length>0&&"string"==typeof e.tokenType&&e.tokenType.length>0&&"number"==typeof e.expiresAt&&Number.isFinite(e.expiresAt)&&"string"==typeof e.baseUrl&&e.baseUrl.length>0}function ev(e){return!!e&&"object"==typeof e&&2===e.version&&"keychain"===e.storage&&"string"==typeof e.credentialAccount&&e.credentialAccount.length>0&&"string"==typeof e.tokenType&&e.tokenType.length>0&&"number"==typeof e.expiresAt&&Number.isFinite(e.expiresAt)&&"string"==typeof e.baseUrl&&e.baseUrl.length>0}async function e_(e){try{return await b.readFile(e,"utf8")}catch(e){eE(e)&&e.code;return}}async function eb(e,t){let r;if(!t.legacyTokenPath||l.resolve(t.legacyTokenPath)===l.resolve(e))return;let a=await e_(t.legacyTokenPath);if(void 0!==a){try{r=JSON.parse(a)}catch{return}if(ey(r))return!t.allowExpired&&eg(r)?void await ew(t.legacyTokenPath,t):(await em(e,r,t),await ew(t.legacyTokenPath,t),r)}}function eS(e){let t;return e.credentialStore??(t=new Q,"darwin"===process.platform?new W(new Z,t):"linux"===process.platform?new W(new ee,t):t)}function ek(e){let t=n.createHash("sha256").update(l.resolve(e)).digest("hex").slice(0,32);return`token:${t}`}function eE(e){return e instanceof Error&&"code"in e}async function eT(e={}){let t=K(e),r=t.fetch??fetch,a=await ex(r,t.baseUrl,t.requestHeaders),o=eD(t.verificationUrl,a.user_code);return t.onVerification?.({userCode:a.user_code,verificationUrl:o,expiresIn:a.expires_in,interval:a.interval}),eP(a.device_code,t,Math.max(1,a.interval),1e3*a.expires_in)}async function eA(e={}){let t=K(e),r=t.fetch??fetch,a=await ex(r,t.baseUrl,t.requestHeaders),o=eD(t.verificationUrl,a.user_code);return t.onVerification?.({userCode:a.user_code,verificationUrl:o,expiresIn:a.expires_in,interval:a.interval}),{userCode:a.user_code,deviceCode:a.device_code,verificationUrl:o,expiresIn:a.expires_in,interval:a.interval}}async function e$(e,t={}){return eP(e,K(t),5,6e5)}async function eP(e,t,r,a){let o=t.fetch??fetch,i=t.sleep??E,n=r,s=Date.now()+a;for(;Date.now()<s;){await i(1e3*n);let a=await eO(o,t.baseUrl,e,t.requestHeaders);if(t.onPoll?.({status:a.status,interval:n}),a.status!==L.Pending){if(a.status===L.SlowDown){n+=r;continue}if(a.status===L.Expired)throw new ef("设备授权已过期,请运行 dbx auth login 重新登录。","DEVICE_AUTH_EXPIRED");if(a.status===L.Invalid)throw new ef("设备授权无效,请运行 dbx auth login 重新登录。","DEVICE_AUTH_INVALID");if(a.status===L.Authorized){if(!a.access_token)throw new ef("无法完成登录:认证服务已确认授权,但未返回 access_token。");let e=function(e,t){let r=Math.floor(Date.now()/1e3);return{accessToken:e.access_token??"",tokenType:e.token_type??"Bearer",expiresAt:"number"==typeof e.expires_at?e.expires_at:r+(e.expires_in??0),baseUrl:t}}(a,t.baseUrl);return await em(t.tokenPath,e,{credentialStore:t.credentialStore}),{accessToken:e.accessToken,tokenType:e.tokenType,expiresAt:e.expiresAt,baseUrl:e.baseUrl,uid:function(e){let t=function(e){let t=e.split(".")[1];if(t)try{let e=Buffer.from(t,"base64url").toString("utf8"),r=JSON.parse(e);return r&&"object"==typeof r?r:void 0}catch{return}}(e),r=t?.uid??t?.sub;return"string"==typeof r&&r.length>0?r:"number"==typeof r&&Number.isFinite(r)?String(r):void 0}(e.accessToken),tokenPath:t.tokenPath}}throw new ef(`无法完成登录:认证服务返回了无法识别的授权状态 status=${String(a.status)}`)}}throw new ef("等待设备授权超时,请运行 dbx auth login 重新发起登录。","DEVICE_AUTH_EXPIRED")}async function ex(e,t,r){let a=await e(`${t}/app_developer/oauth/device/code`,{method:"POST",headers:eI(r),body:JSON.stringify({client_name:"dbx-cli"})}),o=await eU(a),i=eC(o);if(!i||!i.device_code||!i.user_code||"number"!=typeof i.expires_in||"number"!=typeof i.interval)throw new ef(`无法获取登录授权码:认证服务返回的数据缺少必要字段或字段类型不正确(HTTP ${a.status}):${JSON.stringify(o)}`);return i}async function eO(e,t,r,a){let o=await e(`${t}/app_developer/oauth/token`,{method:"POST",headers:eI(a),body:JSON.stringify({device_code:r})}),i=await eU(o),n=eC(i);if(n?.access_token)return{status:L.Authorized,access_token:n.access_token,token_type:n.token_type,expires_in:n.expires_in,expires_at:n.expires_at};if(!n||"number"!=typeof n.status)throw new ef(`无法获取登录凭证:认证服务返回的数据缺少有效的 status 字段(HTTP ${o.status}):${JSON.stringify(i)}`);return n}async function eU(e){var t;let r,a=e.headers.get("x-tt-logid")??void 0;try{r=await e.json()}catch{throw new ef(`无法读取登录结果:认证服务返回的内容不是有效的 JSON(HTTP ${e.status})${eN(a)}`,"DEVICE_AUTH_FAILED",{logId:a})}let o=function(e){if(e&&"object"==typeof e)return"string"==typeof e.log_id&&e.log_id?e.log_id:void 0}(r)??a;if(!e.ok)throw new ef(`认证服务返回 HTTP ${e.status}:${JSON.stringify(r)}${eN(o)}`,"DEVICE_AUTH_FAILED",{logId:o});let i=(t=r)&&"object"==typeof t&&"number"==typeof t.code&&0!==t.code?{code:t.code,message:"string"==typeof t.message?t.message:"未知错误",logId:"string"==typeof t.log_id?t.log_id:void 0}:null;if(i)throw new ef(`认证服务出错(错误码 ${i.code}):${i.message}${eN(i.logId??o)}`,"DEVICE_AUTH_FAILED",{logId:i.logId??o});return r}function eN(e){return e?` [log_id: ${e}]`:""}function eC(e){return e&&"object"==typeof e&&"data"in e?e.data:e}function eI(e){let t=new Headers(e);return t.set("Content-Type","application/json"),t}function eD(e,t){let r=new URL(e);return r.searchParams.set("user_code",t),r.toString()}async function eL(e,t,r){let a;var o,i,n=e,s=r.allowedOrigins;let c=function(e){try{if("string"==typeof e)return new URL(e);if(e instanceof URL)return e;return new URL(e.url)}catch{throw Error("携带登录凭证的请求必须使用完整的 HTTPS URL")}}(n);if("https:"!==c.protocol)throw Error(`携带登录凭证的请求必须使用 HTTPS:${c.toString()}`);if(!s.includes(c.origin))throw Error(`无法向不受信任的来源发送 Authorization 请求头:${c.origin}`);let l=await eh(r.tokenPath,{allowExpired:!0,envTokenBaseUrl:r.baseUrl,credentialStore:r.credentialStore,legacyTokenPath:r.legacyTokenPath});if(!l)throw new ep;if(eg(l))throw new ed;let u=(o=e,i=t,a=new Headers(o instanceof Request?o.headers:void 0),new Headers(i).forEach((e,t)=>{a.set(t,e)}),a);return r.requestHeaders.forEach((e,t)=>{u.set(t,e)}),u.set("Authorization",`${l.tokenType||"Bearer"} ${l.accessToken}`),u}async function eF(e={}){let t,r=K(e);try{t=await eh(r.tokenPath,{envTokenBaseUrl:r.baseUrl,credentialStore:r.credentialStore,legacyTokenPath:r.legacyTokenPath})}catch(e){if(e instanceof z)return{loggedIn:!1,tokenPath:r.tokenPath,baseUrl:r.baseUrl,credentialError:{code:"CREDENTIAL_STORE_UNAVAILABLE",message:e.message}};throw e}if(!t)return{loggedIn:!1,tokenPath:r.tokenPath};let a=await eR(e.fetch??fetch,r.baseUrl,t,r.requestHeaders);return a?{loggedIn:!0,uid:a.userId,name:a.name,avatar:a.avatar,expiresAt:t.expiresAt,tokenPath:r.tokenPath,baseUrl:r.baseUrl}:{loggedIn:!1,expiresAt:t.expiresAt,tokenPath:r.tokenPath,baseUrl:r.baseUrl}}async function eR(e,t,r,a){let o=new Headers(a);o.set("Authorization",`${r.tokenType||"Bearer"} ${r.accessToken}`);let i=await e(`${t.replace(/\/+$/,"")}/app_developer/api/user/basic`,{method:"GET",headers:o});if(!i.ok)return;let n=await i.json();if(0===n.code){var s;return{userId:"string"==typeof(s=n.data?.user_id)&&s.length>0?s:"number"==typeof s&&Number.isFinite(s)?String(s):void 0,name:n.data?.name,avatar:n.data?.avatar}}}(D=L||(L={}))[D.Pending=1]="Pending",D[D.Authorized=2]="Authorized",D[D.Expired=3]="Expired",D[D.Invalid=4]="Invalid",D[D.SlowDown=5]="SlowDown";let eH="DOUBAO_REQUEST_HEADERS_JSON",ej="DBX_BUILD_REQUEST_HEADERS_JSON",eM=new Set(["x-tt-env","x-use-ppe","x-schedule-vdc"]);function eK(e,t){let r;try{r=JSON.parse(e)}catch{throw Error(`${t} 必须是有效的 JSON 对象`)}if("object"!=typeof r||null===r||Array.isArray(r))throw Error(`${t} 必须是 JSON 对象`);let a={};for(let[e,o]of Object.entries(r)){let r=e.toLowerCase();if(eM.has(r)){if("string"!=typeof o)throw Error(`${t} 中请求头 ${r} 的值必须是字符串`);a[r]=o}}return a}let eB=[{agent:"codex",name:"CODEX_THREAD_ID",source:"openai/codex"},{agent:"codex",name:"CODEX_SESSION_ID",source:"openai/codex"},{agent:"claude-code",name:"CLAUDECODE",source:"Claude Code docs"},{agent:"gemini-cli",name:"GEMINI_CLI",source:"Gemini CLI docs"},{agent:"cursor",name:"CURSOR_AGENT",source:"Cursor docs"},{agent:"doubao",name:"DOUBAO_SANDBOX_TYPE",source:"Doubao sandbox environment"}],eJ=["SaaS","Local"],eq=`${process.env.DBX_BUILD_API_BASE_URL||R.apiUrl}/platform/api/v1`,eV=T.create({baseURL:eq,headers:{...R.apiHeaders,...function({compatXTTEnv:e=!0}={}){let t=process.env[eH],r=process.env[ej];void 0!==t&&void 0!==r&&console.warn(`${eH} 与 ${ej} 同时设置,将使用 ${eH} 并忽略 ${ej}`);let a=void 0!==t?eK(t,eH):r?eK(r,ej):{};return e&&process.env.X_TT_ENV&&(a["x-tt-env"]=process.env.X_TT_ENV,a["x-use-ppe"]="1"),a}(),...function(e=process.env){let t=function(e=process.env){for(let{agent:t,name:r}of eB){let a=e[r];if("string"==typeof a&&a.length>0)return t}}(e);return t?{"X-CLI-Agent":t}:{}}(),...function(e=process.env){let t=function(e=process.env){let t=e.DOUBAO_SANDBOX_TYPE?.trim();if(t)return eJ.find(e=>e.toLowerCase()===t.toLowerCase())??void 0}(e);return t?{"x-doubao-sandbox-type":t}:{}}()},method:"GET",timeout:3e4,retry:0,redirect:"error",responseType:"json",ignoreResponseError:!0,async onRequest({request:e,options:t}){let r="string"==typeof e?new URL(e,t.baseURL):e;t.headers=await function(e,t,r={}){return eL(e,t,K(r))}(r,t.headers,{baseUrl:t.baseURL}),t.signal&&t.timeout&&(t.signal=AbortSignal.any([t.signal,AbortSignal.timeout(t.timeout)]))},onResponse({response:e}){let t=e._data;if(!e.ok||t?.code!==0){let r=t?.msg||t?.message||t?.statusText||`接口请求失败(HTTP ${e.status})`,a=[];throw e.headers.has("x-tt-logid")&&a.push(`请求日志 ID:${e.headers.get("x-tt-logid")}`),Error([r,"",...a].join("\n"))}e._data=t.data}});async function eX(e,t){let r=await eV(`/app_developer/check_api/apps/${encodeURIComponent(e.appKey)}/debug/ticket`,{baseURL:R.deviceApiUrl,method:"POST",signal:t,body:{debug_context:JSON.stringify({appletName:e.appKey,appletHost:e.hostUrl,appletType:0,isSigned:!1,isEncrypted:!1,defaultDebugTagState:!0,wifiConnectUrl:e.wifiConnectUrl,...e.versionTag?{versionTag:e.versionTag}:{}})}}),a=g.object({debug_token:g.string().trim().min(1),encrypted_debug_payload:g.string().trim().min(1)}).parse(r);return{debugToken:a.debug_token,qrCodeValue:JSON.stringify({action:"start_real_device_debug",...a})}}function eG(e,t){return eV("/devtool/plugin-mini-app-base-info",{query:{...e},signal:t})}function ez(e,t,r){return eV("/devtool/plugin-package-uploads",{method:"POST",query:{file_name:e},headers:{"Content-Type":"application/zip"},body:t,signal:r})}function eY(e){return eV("/devtool/plugin-material-validations",{method:"POST",body:e})}function eW(){return eV("/devtool/plugin-categories")}function eQ(e){return eV("/devtool/plugin-drafts",{query:{name:e}})}function eZ(e){return eV("/devtool/plugin-drafts",{method:"POST",body:e})}function e0(e){return eV("/devtool/plugin-versions",{method:"POST",body:e})}function e8(e,t){return eV("/devtool/plugin-versions",{query:{...e},signal:t})}function e1(e,t){return eV("/devtool/plugin-versions/build-status",{query:{...e},signal:t})}function e4(e,t){return eV("/devtool/plugin-previews",{method:"POST",body:e,signal:t})}function e3(e,t){return eV("/devtool/plugin-operations",{method:"POST",body:e,signal:t})}function e2(e,t){return eV("/devtool/plugin-approvals/submit",{method:"POST",body:{name:e,version:t}})}function e6(e){return eV("/devtool/plugin-approvals/withdraw",{method:"POST",body:{approval_id:e}})}function e5(e){return eV("/devtool/plugin-approvals/get",{method:"POST",body:{approval_id:e}})}let e7="plugin.json",e9="mcp.json",te="SKILL.md",tt="manifest.yaml",tr="com.doubao/app",ta=["dist","node_modules/.doubao"],to=[".git",".dbx","node_modules"],ti=[".gitkeep",".gitignore",".DS_Store"],tn="templates",ts="standard",tc=".template",tl="__PLUGIN_NAME__",tu="doubao-plugin-cli",tp="doubao-plugin-app";function td(){return!!(process.stdin.isTTY&&process.stdout.isTTY)}function tf(e){console.log(k(e))}function th(e){console.error(k(e))}let tm=td()?m:{info:tf,step:tf,success:tf,warn:th,error:th};function tw(e,t){if(!td())return tm.info(e),t();let r=performance.now();return A(t,{text:` ${e}`,suffixText:()=>`(${Math.floor((performance.now()-r)/1e3)}s)`,successText:` ${e}完成`,stream:process.stdout,discardStdin:!1})}async function tg(e,t,r,a){r?.throwIfAborted();let o=e.title??"应用开发工具",i=l.join(v(),".dbx/tools",e.name,e.version),n=()=>(function(e,t){let r=e.name===R.kit.name?process.env.DBX_KIT_PATH?.trim():void 0;if(!r)return;let a=tv(l.resolve(r,"package.json"),t);if(!a)throw Error(`本地 Kit 的 SDK 入口不存在,请先构建:${r}`);return a})(e,t)??ty(import.meta.url,e,t)??ty(l.join(i,"package.json"),e,t);if(!n()){let n=t_(e,t,i,r);if(a||!td())(a?.log??tm).info(`正在安装${o}`),await n;else{let t=performance.now();await A(n,{text:` 正在安装${o}`,suffixText:()=>`(${Math.floor((performance.now()-t)/1e3)}s)`,successText:` ${o}已安装`,failText:()=>r?.aborted?` 已取消安装${o}`:` ${o}安装失败(${e.name}@${e.version})`,stream:process.stdout,discardStdin:!1})}}let s=n();if(!s)throw Error(`${e.name} 的入口 ${t} 不存在`);return P(s).href}function ty(e,t,r){let a;try{a=$(e).resolve(`${t.name}/package.json`)}catch(e){if("MODULE_NOT_FOUND"===e.code)return;throw e}return tv(a,r,t.version)}function tv(e,t,r){let a=JSON.parse(_.readFileSync(e,"utf8"));if(r&&a.version!==r)return;let o=a.exports?.[t],i="string"==typeof o?o:o?.import,n=i&&l.resolve(l.dirname(e),i);return n&&_.existsSync(n)?n:void 0}async function t_(e,t,r,a){_.mkdirSync(l.dirname(r),{recursive:!0});let o=_.mkdtempSync(`${r}-`);try{let n=i("npm",["install",`${e.name}@${e.version}`,"--prefix",o,"--registry",R.registry,"--no-audit","--no-fund","--loglevel","error"],{stdio:["ignore","ignore","pipe"],signal:a}),s="";n.stderr.setEncoding("utf8").on("data",e=>{s+=e});let[u]=await c(n,"close");if(0!==u)throw Error(`未能安装 ${e.name}@${e.version}(npm 退出码:${u})
|
|
6
|
-
${s.trim()}`);if(!ty(l.join(o,"package.json"),e,t))throw Error(`${e.name}@${e.version} 安装后无法加载,请检查包版本和发布内容。`);try{_.renameSync(o,r)}catch{ty(l.join(r,"package.json"),e,t)||(_.rmSync(r,{recursive:!0,force:!0}),_.renameSync(o,r))}}finally{_.rmSync(o,{recursive:!0,force:!0})}}async function tb(e,t,r){return import(await tg(R.appDev,e,t,r))}let tS=(e,t)=>tg(R.kit,"./sdk",e,t),tk={name:"doubao-app",setup(e){e.init.addOption({flags:"--app",description:"添加应用(App)",prompt:"添加应用(App)?"}),e.init.addOption({flags:"--no-install-deps",description:"创建 App 后不安装前端依赖"}),e.init.onPrepareTemplates(async({options:e})=>{if(!e.app)return[];let{templatesRoot:t}=await tb("./assets");return await tS(),[t]}),e.init.onAfterCreate(async({directory:e,options:t})=>{t.app&&(!1!==t.installDeps&&await tE(d(e,tr)),tm.step(`cd ${u(e)}
|
|
7
|
-
dbx dev --app`))}),e.skills.onProvide(async({project:e})=>{if(!e.app)return[];let{skillsRoot:t}=await tb("./assets");return[{name:tp,root:t,packageName:R.appDev.name,guide:`仅开发豆包 App 的 Page、Widget 或 Manifest 时,先阅读 [应用开发 Skill](.agents/skills/${tp}/SKILL.md)。普通 MCP 和 MCP Apps 不使用 App Manifest。`}]}),e.package.onExclude((e,t)=>"dev"===t?[tr]:[`${tr}/node_modules`]),e.upload.onSuccess(async e=>{if(!e.project.app)return;let{version:t}=await tw("保存预览版本",()=>e0({...e.project.plugin.id?{ability_id:e.project.plugin.id}:{name:e.project.plugin.name},request_id:s()}));if(!t)throw Error("服务端未返回保存的版本号,请到平台草稿页查看。");let{showPreview:r}=await tb("./preview");await r(e.project,t,{withProgress:tw,queryBuildStatus:e1,createPreview:e4,select:async(e,t)=>{let r=await w({message:e,options:[...t]});return h(r)?void 0:r}})}),e.dev.addTarget({name:"app",title:"应用调试(App)",label:"App",option:{flags:"--app",description:"同时启动应用调试(App)"},watch:[e9],appliesTo:({project:e})=>!!e.app,async start(e){let{startApp:t}=await tb(".",e.signal,e);e.signal.throwIfAborted(),await t(e,{loadKit:t=>tS(e.signal,t),queryAppInfo:eG,requestTicket:eX,queryVersions:async()=>{let{id:t,name:r}=e.project.plugin,{items:a=[]}=await e8(t?{ability_id:t}:{name:r},e.signal);return a}})}})}};async function tE(e){tm.info("正在使用 pnpm 安装应用依赖…");try{let t=i("pnpm",["install"],{cwd:e,stdio:[td()?"inherit":"ignore","inherit","inherit"]}),[r]=await c(t,"close");if(0!==r)throw Error(`pnpm 安装失败,退出码:${r}`);tm.success("应用依赖已安装")}catch(t){tm.warn(`应用依赖未安装:${O(t)}`),tm.info(`项目已保留,请进入 ${e} 后运行 pnpm install。`)}}function tT(e=R.name){let t=e.replace(/^@/,"").replace(/[\\/]/g,"+");return d(v(),".dbx","skills",t,"current")}async function tA(e,t){let r=[{name:tu,root:f(import.meta.dirname,"skills"),packageName:R.name,guide:x.readFileSync(d(import.meta.dirname,"templates/standard/AGENTS.md"),"utf8")}];r.push(...await I(t.provideSkills,{project:e}));let a=d(e.root,".gitignore"),o=d(e.root,"AGENTS.md");for(let{name:t,root:i,packageName:n,guide:s}of r){let r=tT(n);tP(i,r);let c=`.agents/skills/${t}`;tP(d(r,t),d(e.root,c));let l=x.existsSync(a)?x.readFileSync(a,"utf8"):"",u=`/${c}`;l.split(/\r?\n/).includes(u)||t$(a,l,`${u}
|
|
8
|
-
`);let p=x.existsSync(o)?x.readFileSync(o,"utf8"):"";s&&!p.includes(`${c}/SKILL.md`)&&t$(o,p,`${p?"\n":""}${s.trim()}
|
|
9
|
-
`)}}function t$(e,t,r){let a=t&&!t.endsWith("\n")?"\n":"";x.writeFileSync(e,`${t}${a}${r}`)}function tP(e,t){let r=x.lstatSync(t,{throwIfNoEntry:!1});if(!r?.isSymbolicLink()||f(p(t),x.readlinkSync(t))!==e){if(r&&!r.isSymbolicLink())throw Error(`开发 Skill 路径已存在且不是软链接,请先确认并移走该路径:${t}`);x.mkdirSync(p(t),{recursive:!0}),x.rmSync(t,{recursive:!0,force:!0}),x.symlinkSync(e,t,"win32"===process.platform?"junction":"dir")}}let tx={name:"builtin",setup(e){e.cli.onSetup(({program:e,hooks:t})=>{let a=new r("--cwd <path>","项目根目录").argParser(e=>f(e)).default(process.cwd()),o=e.command("init").description("创建应用插件项目").argument("[name]","项目名称,同时作为目录名").action(async(e,r)=>{let{runInit:a}=await import("./command~3.js");return a(e,r,t)});for(let{flags:e,description:a}of t.initOptions)o.addOption(new r(e,a));e.command("upload").description("上传应用插件包到开放平台").addOption(a).option("--version <version>","应用插件版本,格式为 x.y.z").action(tO(async(e,r)=>{let{runUpload:a}=await import("./command~5.js");await a(e,r,t)}));let i=t.devTargets.flatMap(({target:e})=>e.option?[new r(e.option.flags,e.option.description)]:[]),n=e.command("dev").description("启动本地开发调试,监听目录变化并同步插件开发包").addOption(new r("--plugin","仅运行默认调试目标").conflicts(i.map(e=>e.attributeName())));i.forEach(e=>n.addOption(e)),n.addOption(a).action(tO(async(e,r)=>{let{runSession:a}=await import("./session.js");await a(e,r,t)})),e.command("uninstall").description("从当前用户卸载插件开发包").addOption(a).action(tO(async e=>{let{runUninstall:t}=await import("./uninstall.js");await t(e)})),e.command("categories").description("查询审核类目,输出包含 category_id 和 name 的 JSON 列表").action(async()=>{let{runCategories:e}=await import("./categories.js");await e()}),e.command("audit").description("完善应用插件草稿、保存版本并提交审核").option("--input <path>","审核材料 JSON 文件;相对路径按项目根目录解析,跳过交互提示").addOption(a).action(tO(async(e,t)=>{let{runAudit:r}=await import("./command.js");await r(e,t)})),e.command("versions").description("查询应用插件各版本的状态和审核信息").addOption(a).action(tO(async e=>{let{runVersions:t}=await import("./versions.js");await t(e)})),e.command("cancel-audit").description("取消应用插件提审").addOption(a).action(tO(async e=>{let{runCancelAudit:t}=await import("./command~2.js");await t(e)})),e.command("skills").description("配置项目开发 Skill").addOption(a).action(tO(async e=>{await tA(e,t),tm.success("项目开发 Skill 已配置")})),e.command("inspect").description("启动本地调试界面,调试 MCP Server 和 MCP Apps").option("--mcp-server [endpoint]","调试 MCP Server,可带地址,如 http://localhost:8088/mcp").option("-H, --header <header>",'请求头,格式为 "Key: Value",可写多次',(e,t=[])=>[...t,e]).option("--port <port>","调试界面端口,默认 6274;被占用时自动顺延").option("--no-open","只启动服务,不打开窗口").action(async e=>{let{runInspect:t}=await import("./command~4.js");await t(e)});let s=e.command("auth").description("认证管理");s.command("login").description("登录").addOption(new r("--begin","发起设备授权并显示操作说明").conflicts("complete")).addOption(new r("--complete <device-code>","使用指定设备码完成授权").conflicts("begin")).action(async e=>{let{runLogin:t}=await import("./command~1.js");await t(e)}),s.command("status").description("查看登录状态").action(async()=>{let{runStatus:e}=await import("./command~1.js");await e()})})}};function tO(e){return async({cwd:t,...r})=>{let{PluginProject:a}=await import("./plugin.js");await e(new a(t),r)}}async function tU(e){try{e.ui.update({status:"pending",message:"正在打包"});let t=await e.packDevelopment();e.signal.throwIfAborted(),e.ui.update({status:"pending",message:"正在上传"});let{package_id:r}=await ez(`${e.project.plugin.name}-${Date.now()}.zip`,t,e.signal);if(!r)throw Error("上传失败:服务端未返回 package_id");e.signal.throwIfAborted(),e.ui.update({status:"pending",message:"正在安装到当前账号"}),await e3({package_id:r,action:"Install"},e.signal),e.ui.update({status:"success",message:"已同步"})}catch(t){e.signal.aborted||(e.ui.update({status:"error",message:"同步失败"}),e.log.error(`平台同步失败:${O(t)}`))}}let tN={name:"platform",setup(e){e.dev.addTarget({name:"platform",title:"插件调试(Skill / MCP)",label:"Skill / MCP",watch:["skills",e9,e7],async start(e){e.onFilesChanged(()=>tU(e)),await tU(e)}})}};async function tC(r=process.argv,a={}){let o=new e().name("dbx").description(R.description).version(R.version,"-V, --version").enablePositionalOptions().configureOutput({outputError:e=>tm.error(e.trimEnd())}).exitOverride();try{await N(o,[tx,tN,tk,...a.plugins??[]]),o.action(()=>o.outputHelp());let e=f(import.meta.dirname,"skills");if(!x.statSync(d(e,tu,"SKILL.md")).isFile())throw Error("CLI 安装包中的开发 Skill 不完整,请重新安装 CLI。");tP(e,tT()),await o.parseAsync(r)}catch(e){if(e instanceof t){process.exitCode=e.exitCode;return}tm.error(e instanceof Error?e.message:String(e)),process.exitCode=1}}export{ta as APP_GENERATED_DIRECTORIES,tt as APP_MANIFEST_FILENAME,tr as DOUBAO_APP_DIRECTORY,e9 as MCP_CONFIG_FILENAME,ep as NotLoggedInError,e7 as PLUGIN_MANIFEST_FILENAME,tl as PLUGIN_NAME_PLACEHOLDER,to as PROJECT_EXCLUDED_DIRECTORIES,ti as PROJECT_EXCLUDED_FILES,te as SKILL_FILENAME,ts as STANDARD_TEMPLATE_DIRECTORY,tn as TEMPLATES_DIRECTORY,tc as TEMPLATE_SUFFIX,C as callHook,I as collectHooks,e$ as completeLogin,O as errorMessage,e5 as getApproval,eQ as getPluginDraft,td as isInteractive,eW as listPluginCategories,e8 as listPluginVersions,tg as loadPackage,eT as login,tC as main,R as runtime,e0 as savePluginVersion,eA as startLogin,e2 as submitApproval,tA as syncProjectSkill,tm as terminal_log,e3 as updateUserPlugin,ez as uploadPackage,eZ as upsertPluginDraft,eY as validateMaterial,eF as whoami,tw as withProgress,e6 as withdrawApproval};
|
package/dist/schema.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{z as e}from"zod";let o="项目名称须为 1 至 64 个小写字母、数字、连字符或点号,以字母或数字开头结尾,且不能包含连续连字符或连续点号。",n=e.string().max(64,o).regex(/^(?!.*(?:--|\.\.))[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$/,o),i=e.string().regex(/^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/,"版本号须为 x.y.z 格式,不能包含前导零"),r=e.record(e.string(),e.unknown()),t=e.looseObject({$schema:e.string().optional(),name:n,id:e.string().optional(),displayName:e.string().optional(),description:e.string().optional(),extensions:r.optional()}),a=e.looseObject({mcpServers:e.record(e.string(),r)});export{a as mcpConfigSchema,t as pluginManifestSchema,n as projectNameSchema,i as versionSchema};
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# 业务 CLI 连接器配置
|
|
2
|
-
|
|
3
|
-
在 `com.doubao/cli.json` 声明工具,无需在 `plugin.json` 登记;客户端通过受控 Shell 在 PC 本地执行:
|
|
4
|
-
|
|
5
|
-
```json
|
|
6
|
-
{
|
|
7
|
-
"connectors": {
|
|
8
|
-
"route-helper": {
|
|
9
|
-
"install": { "default": ["npm install -g @example/route-helper"] },
|
|
10
|
-
"versionCheck": { "default": ["route-helper version"] },
|
|
11
|
-
"auth": { "default": ["route-helper login"] },
|
|
12
|
-
"unAuth": { "default": ["route-helper logout"] },
|
|
13
|
-
"status": { "default": ["route-helper status"] },
|
|
14
|
-
"statusMatchRegex": "^logged in as .+$"
|
|
15
|
-
}
|
|
16
|
-
}
|
|
17
|
-
}
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
将示例包名、命令和正则替换为实际工具配置。业务 CLI 自行管理登录态和凭据,文件中不保存真实凭据;其授权与 `dbx auth` 开发者登录独立。
|
|
21
|
-
|
|
22
|
-
- `connectors` 非空,每包最多 1 个 CLI;名称非空、无首尾空白,且不与 MCP 服务同名。
|
|
23
|
-
- `install` 必填,`versionCheck`、`auth`、`unAuth`、`status` 可选;这些字段均按 `darwin`、`linux`、`win32`、`default` 配置非空命令数组,每条命令非空,提供时须含 `linux` 或 `default`。优先当前系统项,缺少时回退到 `default`。
|
|
24
|
-
- Linux 选中的安装项只支持 npm 安装,推荐 `npm install -g <包名>`;多条命令分项顺序执行,任一失败即安装失败。不支持随包二进制文件或 Package 型连接器。
|
|
25
|
-
- `versionCheck` 用于查询 CLI 版本,例如 `route-helper version`;命令应与实际工具提供的版本查询方式一致。
|
|
26
|
-
- 需要授权时配置 `auth`、`status` 和合法的 `statusMatchRegex`。`auth` 执行登录授权,`status` 查询授权状态,正则匹配状态命令的标准输出判断已授权;命令失败用退出码和标准错误诊断。
|
|
27
|
-
- `unAuth` 用于退出登录或撤销授权,例如 `route-helper logout`;具体清理行为由业务 CLI 实现。
|
|
28
|
-
|
|
29
|
-
业务 Skill 须说明适用请求、命令参数与示例、输出和退出码含义,以及未安装、未授权、无网络和执行失败的处理方式。失败只停用对应 CLI;JSON 或根结构无效、无法定位错误项时停用 CLI 模块,其他能力不受影响。
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# 开发调试
|
|
2
|
-
|
|
3
|
-
## 选择调试目标
|
|
4
|
-
|
|
5
|
-
| 命令 | 行为 |
|
|
6
|
-
| --- | --- |
|
|
7
|
-
| `dbx dev` | 始终调试 Skill / MCP;含 App 时在交互终端询问是否同时调试 App,默认不启动;非 TTY 只调试 Skill / MCP |
|
|
8
|
-
| `dbx dev --plugin` | 只调试 Skill / MCP |
|
|
9
|
-
| `dbx dev --app` | 同时启动平台同步和 App 本地编译、Web 模拟器 |
|
|
10
|
-
|
|
11
|
-
`--plugin` 与 `--app` 互斥。App 编译、模拟器和设备操作见项目内 `.agents/skills/doubao-plugin-app/references/app-development.md`。
|
|
12
|
-
|
|
13
|
-
## 初始化与同步
|
|
14
|
-
|
|
15
|
-
需要有效登录态;交互终端未登录时会发起授权,非 TTY 环境应先按 CLI Skill 的登录说明完成授权。
|
|
16
|
-
|
|
17
|
-
缺少 `plugin.json.id` 时,启动前先上传项目、校验物料并保存平台草稿,将返回的 AbilityID 写回本地;失败则停止启动。这一步不保存版本、不生成预览、不提审,已有 ID 时跳过。
|
|
18
|
-
|
|
19
|
-
平台同步监听业务 `skills/`、MCP 和插件配置,打包上传并安装到当前登录用户,后续变更重新同步安装,不提审、不发布。个人开发包不包含 App 目录;完整 App 包通过 `dbx upload` 上传,上传不执行个人安装。App 本地编译与平台同步并行,分别判断状态。
|
|
20
|
-
|
|
21
|
-
新增或移除 App 后重启并选择调试目标。
|
|
22
|
-
|
|
23
|
-
## Agent 运行方式
|
|
24
|
-
|
|
25
|
-
`dev` 是常驻进程。先检查是否已有可复用实例;需要启动时,以非 TTY 模式通过后台进程工具运行,保留进程句柄,从日志读取状态和地址,不等待进程结束。非 TTY 模式不显示交互菜单、不自动发起登录;需要 App 时显式传入 `--app`。
|
|
26
|
-
|
|
27
|
-
## 停止与卸载
|
|
28
|
-
|
|
29
|
-
Ctrl+C 或退出信号停止调试并清理服务,不会卸载已安装插件。需要卸载时先停止会话,再执行 `dbx uninstall`;会话仍在运行时,后续修改会重新安装。
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
# MCP Apps 接入与验证
|
|
2
|
-
|
|
3
|
-
仅在选择 MCP Apps、需要接通 MCP 工具与 Web UI 时读取。MCP Apps 的 HTML 由 MCP 服务提供;豆包 App 的 Page / Widget 使用 Kit 和 Manifest,二者不是同一套界面协议。只使用 MCP Apps 时无需创建 `com.doubao/app/` 或安装 Kit。
|
|
4
|
-
|
|
5
|
-
## 配置归属
|
|
6
|
-
|
|
7
|
-
| 内容 | 维护位置 |
|
|
8
|
-
| --- | --- |
|
|
9
|
-
| MCP 地址、传输与连接 | 插件根目录 `mcp.json`,沿用普通 MCP 规则 |
|
|
10
|
-
| 服务展示信息 | `plugin.json` 的 `extensions["com.doubao"].mcpServers` |
|
|
11
|
-
| 工具与 `_meta.ui.resourceUri` | MCP 服务端的 `tools/list` |
|
|
12
|
-
| `ui://` HTML、媒体类型和安全元数据 | MCP 服务端的资源返回 |
|
|
13
|
-
| 服务鉴权 | 沿用 MCP OAuth 或静态凭据方案,真实密钥不写入插件包 |
|
|
14
|
-
|
|
15
|
-
不新增插件 UI 清单,不把工具 UI 字段写进 `plugin.json`、`mcp.json` 或 App Manifest。只将 HTML 放入插件包不能替代服务端的工具关联与资源声明。
|
|
16
|
-
|
|
17
|
-
根配置沿用 [项目配置](project-config.md),MCP Apps 只在服务端增加工具与 UI 资源关联。
|
|
18
|
-
|
|
19
|
-
## 接通工具与界面
|
|
20
|
-
|
|
21
|
-
按工程实际 `@modelcontextprotocol/ext-apps` 版本读取 [官方 Quickstart](https://apps.extensions.modelcontextprotocol.io/api/documents/quickstart.html) 与 [server helpers](https://apps.extensions.modelcontextprotocol.io/api/modules/server-helpers.html),保留已有 MCP 和 Web 工程。
|
|
22
|
-
|
|
23
|
-
1. 确认真正使用的工具、输入及结果 schema、样例数据和前端入口。工具须返回独立可读的文字或结构化结果,包含核心数据和状态,不能只返回“请看卡片”、空结果或 UI URI。
|
|
24
|
-
2. 用 `registerAppTool` 注册工具,通过 `_meta.ui.resourceUri` 绑定 `ui://` 资源。
|
|
25
|
-
3. 用 `registerAppResource` 注册同一资源。`resources/read` 的 contents 返回匹配的 URI、实际 HTML 和 `text/html;profile=mcp-app`;安全策略放在 `contents[i]._meta.ui.csp`,只声明实际请求需要的域名。
|
|
26
|
-
4. 前端创建 SDK `App`,先注册处理器再 `app.connect()`;用 `app.ontoolresult` 接收数据,交互通过 `app.callServerTool({ name, arguments })` 调用工具。服务端保留参数校验、授权和业务错误处理。
|
|
27
|
-
5. 按工程实际命令构建,在目标宿主验证 `io.modelcontextprotocol/ui` 扩展协商、资源加载与交互。显示模式读取 `hostContext.availableDisplayModes`,按双方支持情况请求 `inline`、`fullscreen` 或 `pip`,以实际返回为准。
|
|
28
|
-
|
|
29
|
-
服务鉴权参考 [MCP Authorization](https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization),不另设插件 UI 授权字段。完整样例见 [官方运行说明](https://apps.extensions.modelcontextprotocol.io/api/#running-the-examples)。
|
|
30
|
-
|
|
31
|
-
## 调试与验收
|
|
32
|
-
|
|
33
|
-
按 MCP / Web 工程自身命令启动服务。`dbx dev` 只同步插件;`dbx dev --app` 的模拟器用于豆包 App,MCP Apps UI 须在支持它的宿主验证。
|
|
34
|
-
|
|
35
|
-
- 工具:真实调用成功,文字或结构化结果独立可读;业务 Skill 中的参数与 tools/list schema 一致。
|
|
36
|
-
- 界面:读取到关联 URI 的 HTML,工具结果进入 UI;筛选、详情或修改操作调用真实工具并更新界面。
|
|
37
|
-
- 失败:资源不可用、未授权、无数据和业务错误有明确反馈,不伪造成功。
|
|
38
|
-
- 宿主不支持 UI:基础工具结果仍可读;记录未完成的交互能力,不能将普通 MCP 连接成功或平台同步成功当作 UI 验收通过。
|
|
39
|
-
|
|
40
|
-
字段依据 [MCP Apps 2026-01-26 规范](https://github.com/modelcontextprotocol/ext-apps/blob/main/specification/2026-01-26/apps.mdx),按工程 SDK 与宿主版本核对。
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
# MCP 鉴权配置
|
|
2
|
-
|
|
3
|
-
在 `mcp.json` 声明服务。无需鉴权或使用标准 MCP OAuth 时,不需要额外鉴权文件,也不重复声明 OAuth 地址或客户端凭据;远程服务按需进入 OAuth,`stdio` 默认无需鉴权。
|
|
4
|
-
|
|
5
|
-
静态 API Key 或 Token 使用 `com.doubao/auth/<服务键>.json`,如 `mcpServers.routes` 对应 `com.doubao/auth/routes.json`。文件须直接位于该目录,服务键不得含 `/` 或 `\`。真实凭据由用户输入、客户端管理,包内只声明输入项和注入模板:
|
|
6
|
-
|
|
7
|
-
```json
|
|
8
|
-
{
|
|
9
|
-
"credentials": [
|
|
10
|
-
{ "id": "apiKey", "label": "API Key", "secret": true }
|
|
11
|
-
],
|
|
12
|
-
"injections": [
|
|
13
|
-
{ "target": "header", "name": "Authorization", "value": "Bearer ${apiKey}" }
|
|
14
|
-
]
|
|
15
|
-
}
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
- 两个数组均非空。凭据 `id` 唯一,以字母开头,仅含字母、数字和下划线;`label` 非空,`secret` 必填,密钥和 Token 设为 `true`。可选字段:`required` 默认 `true`,`description` 最多 1024 字符。
|
|
19
|
-
- 远程 MCP 只用 `header`;`stdio` 只用 `env`,如 `{ "target": "env", "name": "ROUTES_API_KEY", "value": "${apiKey}" }`。`name` 非空,同一目标内唯一,且不与 `mcp.json` 已有配置冲突;请求头名称忽略大小写。
|
|
20
|
-
- `value` 至少引用一个同文件声明的 `${id}`,仅做一次原文替换。可选凭据为空时省略引用它的注入项;无凭据的固定请求头写入 `mcp.json`。
|
|
21
|
-
- 凭据仅可注入请求头或环境变量;Header 凭据只发往配置的源站,跨源重定向不得携带。
|
|
22
|
-
|
|
23
|
-
文件位置或服务关联错误会阻止提交;鉴权配置无效会停用对应 MCP 服务。按错误提示修复,其他有效服务独立加载。
|
|
@@ -1,139 +0,0 @@
|
|
|
1
|
-
# 项目配置
|
|
2
|
-
|
|
3
|
-
字符串长度按 Unicode 码点计数,“非空”不包含纯空白字符串。
|
|
4
|
-
|
|
5
|
-
## Table of Contents
|
|
6
|
-
|
|
7
|
-
- [创建与文件归属](#创建与文件归属)
|
|
8
|
-
- [plugin.json:身份与展示信息](#pluginjson身份与展示信息)
|
|
9
|
-
- [mcp.json:连接服务](#mcpjson连接服务)
|
|
10
|
-
- [业务 Skill:用途、参数与结果](#业务-skill用途参数与结果)
|
|
11
|
-
- [选择界面能力](#选择界面能力)
|
|
12
|
-
|
|
13
|
-
## 创建与文件归属
|
|
14
|
-
|
|
15
|
-
| 命令 | 创建内容 |
|
|
16
|
-
| --- | --- |
|
|
17
|
-
| `dbx init <name>` | 空插件骨架:根配置与开发指引,需补充实际业务能力 |
|
|
18
|
-
| `dbx init <name> --app` | 增加 App、本地商品搜索端工具、业务 Skill、页面和卡片 |
|
|
19
|
-
|
|
20
|
-
目标目录须不存在或为空,初始化无需登录。非 TTY 环境传入项目名,以 `--app` 选择 App;交互终端可按提示选择。
|
|
21
|
-
|
|
22
|
-
App 模式准备 Kit 和前端依赖;`--no-install-deps` 跳过依赖安装。安装失败保留项目,在 `com.doubao/app/` 重试 `pnpm install`。
|
|
23
|
-
|
|
24
|
-
| 文件 | 作用 |
|
|
25
|
-
| --- | --- |
|
|
26
|
-
| `plugin.json` | 插件身份、版本及平台展示信息 |
|
|
27
|
-
| `mcp.json` | MCP 服务地址、传输方式和连接配置 |
|
|
28
|
-
| `com.doubao/app/tools.json` | App 端工具定义,与 App 的 Manifest、package.json 同级 |
|
|
29
|
-
| `skills/<name>/SKILL.md` | 上传的业务能力与工具使用指引 |
|
|
30
|
-
| `.agents/skills/` | 给开发 Agent 的指引,不上传为业务能力 |
|
|
31
|
-
|
|
32
|
-
MCP 连接和展示信息放在插件根目录;`extensions["com.doubao"]` 适用于整个插件。平台扩展放在该命名空间,`id` 按下文处理,不自行增加顶层字段或改写模块位置。
|
|
33
|
-
|
|
34
|
-
图标字段以 `./` 开头:Plugin、MCP 图标相对插件根目录,Skill 图标相对当前 Skill 目录。Skill 正文中的资源引用也相对当前 Skill 目录,解析后不得越出各自目录。引用文件须随包交付;CLI 不打包软链接,应保留实际文件。
|
|
35
|
-
|
|
36
|
-
## plugin.json:身份与展示信息
|
|
37
|
-
|
|
38
|
-
以下示例使用 `shopping` 服务键。修改已有配置时按键合并,保留 `id` 和其他能力。
|
|
39
|
-
|
|
40
|
-
```json
|
|
41
|
-
{
|
|
42
|
-
"$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
|
|
43
|
-
"name": "my-plugin",
|
|
44
|
-
"version": "0.0.1",
|
|
45
|
-
"description": "根据关键词搜索商品",
|
|
46
|
-
"extensions": {
|
|
47
|
-
"com.doubao": {
|
|
48
|
-
"displayName": { "zh": "商品助手", "en": "Shopping assistant" },
|
|
49
|
-
"displayDescription": { "zh": "搜索商品并查看规格和价格", "en": "Search products and view their prices" },
|
|
50
|
-
"mcpServers": {
|
|
51
|
-
"shopping": {
|
|
52
|
-
"displayName": { "zh": "商品搜索", "en": "Product search" },
|
|
53
|
-
"displayDescription": { "zh": "按关键词搜索商品", "en": "Search products by keyword" }
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
- `name` 必填,是稳定包标识:1~64 字符,仅小写英文字母、数字、点号或连字符,首尾为字母或数字,不含连续 `--` 或 `..`;修改展示名称时保留它。
|
|
62
|
-
- `description` 可选,为字符串,最多 1024 字符。
|
|
63
|
-
- `id` 是开放平台 AbilityID,字符串类型,由 CLI 保存草稿后回填;有值时优先按它定位,否则按 `name`。保留已有值,不自行生成,不与 ActionHub PluginID 或 App 的 `app_key` 混用;该平台字段不在通用 schema 中。
|
|
64
|
-
- 协议中的 `version` 可选,为字符串,提供时须与发布提交的版本一致。CLI 的 `dbx upload --version x.y.z` 仅接受无前导零的三段数字,覆盖上传包中的版本,不修改本地清单。
|
|
65
|
-
- `mcpServers.shopping` 是服务展示信息;键集合须与 `mcp.json.mcpServers` 逐一对应,不能缺少或多出服务键。这里的 `shopping` 不是工具名 `search_products`。
|
|
66
|
-
|
|
67
|
-
展示字段:
|
|
68
|
-
|
|
69
|
-
| 位置 | 字段 | 要求 |
|
|
70
|
-
| --- | --- | --- |
|
|
71
|
-
| `extensions["com.doubao"]` | `displayName`、`displayDescription` | Plugin 展示文案可选;分别最多 128、1024 字符 |
|
|
72
|
-
| 同命名空间的 `mcpServers.<服务键>` | `displayName`、`displayDescription` | 每个 MCP 服务均必填;分别最多 128、1024 字符 |
|
|
73
|
-
|
|
74
|
-
以上字段为多语言对象,键使用小写两字母语言代码(如 `zh`、`en`,不使用 `zh-CN`),值为字符串,每个对象至少一个值非空,长度逐值检查。MCP 展示文案放在 `plugin.json`,不放入连接配置。图标要求见 [上传与审核](upload.md)。
|
|
75
|
-
|
|
76
|
-
## mcp.json:连接服务
|
|
77
|
-
|
|
78
|
-
需要远端 MCP 时填写实际服务地址。App 模板默认使用本地端工具,MCP 服务列表为空。以下 URL 仅作占位,接入业务服务时同步更新展示配置和 Skill。
|
|
79
|
-
|
|
80
|
-
```json
|
|
81
|
-
{
|
|
82
|
-
"$schema": "https://agent-plugins.org/schemas/1.0.0/mcp.schema.json",
|
|
83
|
-
"mcpServers": {
|
|
84
|
-
"shopping": {
|
|
85
|
-
"type": "streamable-http",
|
|
86
|
-
"url": "https://example.com/mcp"
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
}
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
远程服务使用 HTTPS 绝对 URL,不指向 `localhost` 或回环 IP,不包含用户名、密码或片段。`headers` 仅存非敏感固定值,请求头名称按大小写不敏感判重;静态凭据见 [MCP 鉴权](mcp-auth.md)。
|
|
93
|
-
|
|
94
|
-
当前 App 调试适配单个 `streamable-http` 服务,不启动本地 MCP 子进程。主协议还定义了 `stdio`、`sse`,不能由协议声明推断当前 App 调试支持这些传输。
|
|
95
|
-
|
|
96
|
-
工具定义来自 MCP `tools/list`,不写入连接配置。真实凭据不打包;URL 和 headers 中不依赖 `${ENV}` 展开。
|
|
97
|
-
|
|
98
|
-
## 业务 Skill:用途、参数与结果
|
|
99
|
-
|
|
100
|
-
Skill 位于 `skills/<name>/SKILL.md`,必须是 `skills/` 的直接子目录。
|
|
101
|
-
|
|
102
|
-
| Frontmatter 字段 | 要求 |
|
|
103
|
-
| --- | --- |
|
|
104
|
-
| `name` | 必填,1~64 字符,仅小写英文字母、数字和连字符,首尾不为连字符、不含 `--`,与目录名一致 |
|
|
105
|
-
| `description` | 必填,非空,最多 1024 字符,说明适用请求 |
|
|
106
|
-
| `metadata.display_name` | 必填,非空字符串,最多 128 字符 |
|
|
107
|
-
| `metadata.display_description` | 必填,非空字符串,最多 1024 字符 |
|
|
108
|
-
|
|
109
|
-
`metadata` 的值均为字符串,YAML 映射不允许重复键。Plugin 名称可含点号,Skill 名称不可。正式发布时 Skill 名称须全平台唯一;个人调试由服务端派生隔离名称,源包名称保持不变。
|
|
110
|
-
|
|
111
|
-
以下购物示例保存为 `skills/my-plugin/SKILL.md`:
|
|
112
|
-
|
|
113
|
-
```markdown
|
|
114
|
-
---
|
|
115
|
-
name: my-plugin
|
|
116
|
-
description: 用户希望按关键词搜索商品、查看规格或价格时,调用 shopping 的 search_products 工具。
|
|
117
|
-
metadata:
|
|
118
|
-
display_name: 商品搜索
|
|
119
|
-
display_description: 根据关键词搜索商品,查看名称、规格和价格。
|
|
120
|
-
---
|
|
121
|
-
|
|
122
|
-
# 商品搜索
|
|
123
|
-
|
|
124
|
-
确认搜索需求,按 search_products 的实际 inputSchema 组织参数并调用;依据工具结果展示商品,无结果或失败时说明原因。
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
正文说明必要输入、工具调用、结果和失败处理;参数以实际 `tools/list` 的 `inputSchema` 为准。
|
|
128
|
-
|
|
129
|
-
业务资料按需放入 `references/`、`scripts/`、`assets/`,随 Skill 交付并在正文引用。开发指引放 `.agents/skills/`。
|
|
130
|
-
|
|
131
|
-
## 选择界面能力
|
|
132
|
-
|
|
133
|
-
- 普通 MCP:提供工具结果,业务 Skill 说明调用方式。
|
|
134
|
-
- MCP Apps:服务端提供 `ui://` HTML,见 [MCP Apps](mcp-apps.md)。
|
|
135
|
-
- 豆包 App:页面、Widget 和 Manifest 由项目的 `doubao-plugin-app` Skill 指导。
|
|
136
|
-
|
|
137
|
-
远端 MCP 和 HTML 服务须独立部署;`dbx upload` 只上传插件包。工具、界面和平台上传分别验证。
|
|
138
|
-
|
|
139
|
-
打包排除嵌套的独立插件项目,保留所属 App 源码和业务资源。
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
# 上传与审核
|
|
2
|
-
|
|
3
|
-
| 命令 | 行为 |
|
|
4
|
-
| --- | --- |
|
|
5
|
-
| `dbx upload` | 上传、校验并保存草稿和 ID;含 App 时另存版本、等待云构建并生成预览,不执行个人安装或提审 |
|
|
6
|
-
| `dbx audit` | 使用已上传草稿和审核材料保存版本、提交审核,不上传本地改动 |
|
|
7
|
-
| `dbx versions` | 以 JSON 查询各版本状态和审核摘要 |
|
|
8
|
-
| `dbx cancel-audit` | 撤回最新有审核记录版本的提审 |
|
|
9
|
-
|
|
10
|
-
仅执行用户要求的操作。上传后输出草稿链接,后续保存版本、构建或预览失败时可从该链接继续处理。本地修改后须重新上传;`--version x.y.z` 仅覆盖包内版本,平台保存版本时自动递增。
|
|
11
|
-
|
|
12
|
-
审核材料包括一项意向分类、按鉴权要求提供的 MCP 测试账号或 Key、每个 Skill 和应用插件的 HTTP 或 HTTPS 评测报告地址和 5–10 条示例提示词,以及每个 CLI 的使用说明文档链接。OAuth 测试凭据必填;其他鉴权方式由服务端校验。已有材料会预填,脱敏凭据不修改则保留。
|
|
13
|
-
|
|
14
|
-
图标声明位置与路径见 [项目配置](project-config.md),图片要求如下:
|
|
15
|
-
|
|
16
|
-
| 图标 | 要求 |
|
|
17
|
-
| --- | --- |
|
|
18
|
-
| 普通 Plugin 主图标、`chatIcon`、Skill 和 MCP 图标 | 可选;PNG / JPEG,512×512,单张 ≤500 KB |
|
|
19
|
-
| 含 App 的 Plugin 主图标 | 首次创建关联 App 时必填;GIF / JPEG / PNG / WebP,512×512,≤10 MiB,四角像素均不能完全透明 |
|
|
20
|
-
|
|
21
|
-
主图标在 `plugin.json` 的 `extensions["com.doubao"].icon` 声明,如 `./com.doubao/assets/icon.png`;`chatIcon` 未提供时复用主图标。检查文件实际格式、尺寸和大小,保留已有有效配置;两个字段可引用同一文件。
|
|
22
|
-
|
|
23
|
-
校验失败按返回的文件和字段修复;提审失败保留版本号和错误信息,避免重复保存版本。
|
|
24
|
-
|
|
25
|
-
### 非交互审核
|
|
26
|
-
|
|
27
|
-
非 TTY 默认复用草稿的分类和有效材料;补充或修改时使用 `--input`,指定后不显示交互提示:
|
|
28
|
-
|
|
29
|
-
```sh
|
|
30
|
-
dbx audit --cwd ./my-plugin --input ../audit-input.json
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
`--input` 的相对路径以项目根目录为基准。文件示例:
|
|
34
|
-
|
|
35
|
-
```json
|
|
36
|
-
{
|
|
37
|
-
"category_id": "category-id",
|
|
38
|
-
"modules": [
|
|
39
|
-
{
|
|
40
|
-
"module_id": "mcp-module-id",
|
|
41
|
-
"mcp": { "test_credential": "test-account-or-key" }
|
|
42
|
-
},
|
|
43
|
-
{
|
|
44
|
-
"module_id": "skill-module-id",
|
|
45
|
-
"skill": {
|
|
46
|
-
"evaluation_report_url": "https://example.com/report",
|
|
47
|
-
"example_prompts": ["核心场景一", "核心场景二", "核心场景三", "核心场景四", "核心场景五"]
|
|
48
|
-
}
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
"module_id": "app-module-id",
|
|
52
|
-
"mini_app": {
|
|
53
|
-
"evaluation_report_url": "https://example.com/report",
|
|
54
|
-
"example_prompts": ["核心场景一", "核心场景二", "核心场景三", "核心场景四", "核心场景五"]
|
|
55
|
-
}
|
|
56
|
-
},
|
|
57
|
-
{
|
|
58
|
-
"module_id": "cli-module-id",
|
|
59
|
-
"cli": { "instruction_document_url": "https://example.com/docs" }
|
|
60
|
-
}
|
|
61
|
-
]
|
|
62
|
-
}
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
MCP Apps 兼容使用 `mcp_app.mcp.test_credential`。
|
|
66
|
-
|
|
67
|
-
分类 ID 通过 `dbx categories` 查询;`module_id` 使用服务端草稿返回值,不根据模块名称自行生成。当前 CLI 不提供草稿详情查询;拿不到模块 ID 时,在 `dbx upload` 返回的 Web 草稿页面完善材料,再运行 `dbx audit` 复用。
|
|
68
|
-
|
|
69
|
-
未指定的材料沿用有效旧值,脱敏凭据不会作为新凭据上传;材料无效时在保存版本和提审前退出。
|
|
70
|
-
|
|
71
|
-
交互终端的预览支持切换二维码大小、在浏览器中查看二维码或完成并退出,并显示插件、版本和有效期。非 TTY 模式输出文本二维码和预览链接后自动结束;草稿链接用于管理配置与提审。
|