@huaweidevtools/aishell-dsh-huaweicloud-docs 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined in Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is derived from (or based upon) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Huawei Cloud AI Shell
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

package/README.md

@@ -1,3 +1,64 @@
-# Temporary Holding Version
+# @huaweidevtools/aishell-dsh-huaweicloud-docs
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Tells DSH's model where to read Huawei Cloud product documentation. One system-prompt section; no tools, no browser half, no other dependency.
+
+## What it injects
+
+```
+Huawei Cloud product documentation — for what a product is, what it supports,
+its quotas and limits, or its billing model — is indexed at
+https://support.huaweicloud.com/llms.txt
+
+That index lists every Huawei Cloud product by category, each entry naming the
+product's own llms.txt. Read it to find the product, then read that product's
+file for the detail. Do not answer questions about a product's capabilities or
+limits from memory; they change between releases, and the documentation is the
+authority.
+```
+
+## Why only a pointer
+
+The index itself is ~35 KB of product names — real value, but a per-turn cost of roughly 9k tokens, of which any one task needs a single entry. So the section carries the pointer, and the model fetches the index — and then the one product under it — with the web-fetch tool it already has. That is the shape `llms.txt` exists for.
+
+The URL answers: `https://support.huaweicloud.com/llms.txt` returns the index as `text/plain` (~35 KB), and each product entry links to that product's own file — ECS, for one, resolves to ~500 KB of real documentation. `web_fetch`'s User-Agent is `deepseek-harness/0.0.1 (+https://github.com/deepseek-ai)`.
+
+That User-Agent is not something the model can set. `web_fetch` exposes no header parameter — the value is a plugin `Config` field (`userAgent`) defaulting to the constant above. So any instruction to fetch with a particular browser User-Agent is unactionable for the model, and this package issues none.
+
+## Where it sits in the prompt
+
+Early — immediately after the deployment persona prefix, ahead of every policy and tool section. Background knowledge is worth having before the model starts planning, rather than discovering it once it reaches the tool list.
+
+Measured against the real `SystemPrompt` service, the assembled prompt reads:
+
+```
+harness:identity            -1000
+deployment:persona-prefix       0
+aishell:huaweicloud-docs      100   ← this plugin
+plan:policy                   500
+tool:*                    1000+
+deployment:persona-suffix   10200
+```
+
+So it lands inside the persona envelope (the prefix opens at `0`, the suffix closes at `10200`) and before every policy and tool slot. The position is a number (`HUAWEICLOUD_DOCS_ORDER = 100`) rather than one of the framework's named slots, because its placement table is closed: `PromptSectionOrderName` is `keyof` a fixed constant, so a `HUAWEICLOUD_DOCS` name has nowhere to go. The table leaves the gap between `0` and `500` empty, and `100` sits inside it.
+
+A section rather than a runtime context because the URL never changes. `context()` is for facts that flip — the read-only policy uses it for exactly that reason — and a constant belongs in a section.
+
+## Install
+
+```sh
+# On its own.
+dsh plugin --profile <name> add @huaweidevtools/aishell-dsh-huaweicloud-docs
+
+# Or with the rest of the aishell plugin set.
+dsh plugin --profile <name> add @huaweidevtools/aishell-dsh-base
+```
+
+## What it does NOT touch
+
+- No tools. The model uses its existing web-fetch tool; this plugin adds none.
+- No credentials, no network calls of its own.
+- No browser half — nothing to render.
+
+## License
+
+Apache License 2.0.

package/cordis.patch.yml

@@ -0,0 +1,10 @@
+# aishell-huaweicloud-docs bundle patch: inserts the documentation pointer.
+# Install standalone: `dsh plugin --profile <name> add @huaweidevtools/aishell-dsh-huaweicloud-docs`
+#
+# The single row mounts a host-only plugin: it registers one system-prompt
+# section naming the Huawei Cloud documentation index. It has no browser half
+# and no tools — the model reads the index with the ordinary web-fetch tool it
+# already has.
+- insert:
+    - id: aishell-huaweicloud-docs
+      name: '@huaweidevtools/aishell-dsh-huaweicloud-docs'

package/lib/index.js

@@ -0,0 +1,68 @@
+//#region src/index.ts
+/**
+* Position of the documentation pointer in the assembled prompt.
+*
+* A number, not a name, because the framework's placement table is closed:
+* `PromptSectionOrderName` is `keyof` a fixed constant, and
+* `getSectionOrder('HUAWEICLOUD_DOCS')` would return `undefined` — there is no
+* slot for product-domain background. Every shipped plugin reads a name from
+* that table, so this is the one place this package departs from them.
+*
+* The table's own entries leave the gap between the persona prefix (0) and the
+* first policy (500) empty, and 100 sits inside it. Note that "ahead of the
+* persona" would be wrong as well as worse: the persona opens at 0, so the only
+* order that precedes it is a negative one — before `harness:identity` at
+* -1000, i.e. before the prompt has said what it is. 100 puts this after the
+* persona and before anything the model is asked to reason about.
+*/
+const HUAWEICLOUD_DOCS_ORDER = 100;
+/** Name this contribution registers under; unique across the assembled prompt. */
+const DOCS_SECTION_NAME = "aishell:huaweicloud-docs";
+/** The Huawei Cloud documentation index. */
+const DOCS_INDEX_URL = "https://support.huaweicloud.com/llms.txt";
+/**
+* What the model reads.
+*
+* The last sentence is the load-bearing one: a model asked about a product's
+* quotas or billing will otherwise answer from memory, and those numbers move
+* between releases. Naming the authority is what makes the pointer worth
+* carrying.
+*/
+const DOCS_POINTER = `Huawei Cloud product documentation — for what a product is, what it supports, its quotas and limits, or its billing model — is indexed at ${DOCS_INDEX_URL}
+
+That index lists every Huawei Cloud product by category, each entry naming the product's own llms.txt. Read it to find the product, then read that product's file for the detail. Do not answer questions about a product's capabilities or limits from memory; they change between releases, and the documentation is the authority.`;
+/**
+* Register the documentation pointer.
+*
+* Deferred behind `ctx.inject` rather than declared in this plugin's own
+* `inject`: the pointer is an enhancement, and a deployment without the system
+* prompt should lose the pointer rather than fail to mount.
+*
+* @param ctx - host context.
+*/
+function registerDocsPointer(ctx) {
+	ctx.inject(["systemPrompt"], (scope) => {
+		scope.systemPrompt.section({
+			name: DOCS_SECTION_NAME,
+			order: HUAWEICLOUD_DOCS_ORDER,
+			interpolate: false,
+			text: DOCS_POINTER
+		});
+	});
+}
+const name = "aishell-huaweicloud-docs";
+/**
+* No required services.
+*
+* The one dependency is taken through `ctx.inject` inside
+* {@link registerDocsPointer}, so a deployment without a system prompt loses
+* the pointer instead of the whole entry failing to activate.
+*/
+const inject = [];
+function apply(ctx) {
+	registerDocsPointer(ctx);
+}
+
+//#endregion
+export { DOCS_INDEX_URL, DOCS_POINTER, DOCS_SECTION_NAME, HUAWEICLOUD_DOCS_ORDER, apply, inject, name, registerDocsPointer };
+//# sourceMappingURL=index.js.map

package/lib/types/index.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Huawei Cloud product-documentation pointer for DSH.
+ *
+ * ## What this injects, and why it is only a pointer
+ *
+ * One fact: where to read Huawei Cloud's product documentation. The index at
+ * `llms.txt` is ~35 KB of product names — real value, but a per-turn cost of
+ * roughly 9k tokens, of which a given task needs one entry. So the plugin
+ * carries the pointer and lets the model fetch the index (and then the one
+ * product under it) with the web-fetch tool it already has. That is the shape
+ * `llms.txt` is designed for.
+ *
+ * ## Why a prompt section and not a runtime context
+ *
+ * The URL never changes, so this is static knowledge rather than session state.
+ * `systemPrompt.section()` is the registration for text that is always present;
+ * `context()` is for facts that flip (the read-only policy uses it for that
+ * reason — it appears and disappears with the mode). A section is re-rendered
+ * on every assembly either way; the difference is that a context snapshot is
+ * only committed when its text changes.
+ *
+ * ## Where it sits in the prompt
+ *
+ * Early: immediately after the deployment persona prefix, ahead of every policy
+ * and tool section. Background knowledge is worth reading before the model
+ * starts planning — it should know where to look things up, not discover it
+ * once it has reached the tool list.
+ *
+ * Measured, not asserted — mounting this plugin against the real `SystemPrompt`
+ * service renders, in order: `harness:identity`, the persona prefix, this
+ * section, then the policy and tool slots, then the persona suffix.
+ *
+ * @module @huaweidevtools/aishell-dsh-huaweicloud-docs
+ */
+import type { Context } from '@deepseek-ai/cordis';
+/**
+ * Position of the documentation pointer in the assembled prompt.
+ *
+ * A number, not a name, because the framework's placement table is closed:
+ * `PromptSectionOrderName` is `keyof` a fixed constant, and
+ * `getSectionOrder('HUAWEICLOUD_DOCS')` would return `undefined` — there is no
+ * slot for product-domain background. Every shipped plugin reads a name from
+ * that table, so this is the one place this package departs from them.
+ *
+ * The table's own entries leave the gap between the persona prefix (0) and the
+ * first policy (500) empty, and 100 sits inside it. Note that "ahead of the
+ * persona" would be wrong as well as worse: the persona opens at 0, so the only
+ * order that precedes it is a negative one — before `harness:identity` at
+ * -1000, i.e. before the prompt has said what it is. 100 puts this after the
+ * persona and before anything the model is asked to reason about.
+ */
+export declare const HUAWEICLOUD_DOCS_ORDER = 100;
+/** Name this contribution registers under; unique across the assembled prompt. */
+export declare const DOCS_SECTION_NAME = "aishell:huaweicloud-docs";
+/** The Huawei Cloud documentation index. */
+export declare const DOCS_INDEX_URL = "https://support.huaweicloud.com/llms.txt";
+/**
+ * What the model reads.
+ *
+ * The last sentence is the load-bearing one: a model asked about a product's
+ * quotas or billing will otherwise answer from memory, and those numbers move
+ * between releases. Naming the authority is what makes the pointer worth
+ * carrying.
+ */
+export declare const DOCS_POINTER = "Huawei Cloud product documentation \u2014 for what a product is, what it supports, its quotas and limits, or its billing model \u2014 is indexed at https://support.huaweicloud.com/llms.txt\n\nThat index lists every Huawei Cloud product by category, each entry naming the product's own llms.txt. Read it to find the product, then read that product's file for the detail. Do not answer questions about a product's capabilities or limits from memory; they change between releases, and the documentation is the authority.";
+/**
+ * Register the documentation pointer.
+ *
+ * Deferred behind `ctx.inject` rather than declared in this plugin's own
+ * `inject`: the pointer is an enhancement, and a deployment without the system
+ * prompt should lose the pointer rather than fail to mount.
+ *
+ * @param ctx - host context.
+ */
+export declare function registerDocsPointer(ctx: Context): void;
+export declare const name = "aishell-huaweicloud-docs";
+/**
+ * No required services.
+ *
+ * The one dependency is taken through `ctx.inject` inside
+ * {@link registerDocsPointer}, so a deployment without a system prompt loses
+ * the pointer instead of the whole entry failing to activate.
+ */
+export declare const inject: readonly string[];
+export declare function apply(ctx: Context): void;
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "@huaweidevtools/aishell-dsh-huaweicloud-docs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "description": "Points DSH's model at Huawei Cloud's product documentation index (support.huaweicloud.com/llms.txt)",
+  "version": "0.0.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yusheng-g/aishell-dsh-plugins.git",
+    "directory": "packages/aishell-huaweicloud-docs"
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/index.js"
+    }
+  },
+  "files": [
+    "lib/index.js",
+    "lib/types/**/*.d.ts",
+    "cordis.patch.yml"
+  ],
+  "license": "Apache-2.0",
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "^4.0.4",
+    "@deepseek-ai/dsh-system-prompt": ">=0.2.0-0 <0.3.0-0"
+  },
+  "devDependencies": {
+    "@deepseek-ai/cordis": "^4.0.4",
+    "@deepseek-ai/dsh-system-prompt": ">=0.2.0-0 <0.3.0-0",
+    "tsdown": "^0.10.0",
+    "typescript": "^5.7.0"
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    }
+  },
+  "scripts": {
+    "build:bundle": "tsdown"
+  }
 }