@aigne/doc-smith 0.0.1

package/docs-mcp/get-docs-detail.mjs

@@ -0,0 +1,42 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+
+const docsDir =
+  "/Users/lban/arcblock/code/arcblock-sdk-docs/packages/aigne-framework/docs/";
+
+export default async function getDocDetail({ path: docPath }) {
+  try {
+    // Flatten path: remove leading /, replace all / with - (same logic as utils.mjs)
+    const flatName = docPath.replace(/^\//, "").replace(/\//g, "-");
+    const fileFullName = `${flatName}.md`;
+    const filePath = path.join(docsDir, fileFullName);
+
+    // Read the markdown file
+    const content = await fs.readFile(filePath, "utf8");
+
+    return {
+      success: true,
+      path: docPath,
+      content,
+      filePath,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      path: docPath,
+      error: error.message,
+    };
+  }
+}
+
+getDocDetail.input_schema = {
+  type: "object",
+  properties: {
+    path: {
+      type: "string",
+      description: "The path of the docs to get detail",
+    },
+  },
+};
+
+getDocDetail.description = "Get AIGNE Framework single docs detail";

package/docs-mcp/get-docs-structure.mjs

@@ -0,0 +1,11 @@
+import fs from "node:fs/promises";
+
+const structureDir =
+  "/Users/lban/arcblock/code/arcblock-sdk-docs/packages/aigne-framework/output/structure-plan.json";
+
+export default async function getDocsStructure() {
+  const structure = await fs.readFile(structureDir, "utf-8");
+  return { structure };
+}
+
+getDocsStructure.description = "Get AIGNE Framework docs structure";

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@aigne/doc-smith",
+  "version": "0.0.1",
+  "description": "",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "biome check && pnpm -r run lint",
+    "update:deps": "npx -y taze major -r -w -f -n '/@abtnode|@aigne|@arcblock|@blocklet|@did-connect|@did-pay|@did-space|@nft-store|@nft-studio|@ocap/' && pnpm install && pnpm run deduplicate",
+    "deduplicate": "pnpm dedupe",
+    "lint:fix": "biome check --write && pnpm -r run lint"
+  },
+  "type": "module",
+  "bin": "aigne.yaml",
+  "keywords": [],
+  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
+  "license": "MIT",
+  "dependencies": {
+    "@aigne/anthropic": "^0.10.2",
+    "@aigne/cli": "^1.26.0",
+    "@aigne/core": "^1.39.0",
+    "@aigne/gemini": "^0.8.6",
+    "@aigne/openai": "^0.10.6",
+    "@aigne/publish-docs": "^0.4.0",
+    "glob": "^11.0.3",
+    "open": "^10.2.0",
+    "ufo": "^1.6.1",
+    "yaml": "^2.8.0"
+  }
+}

package/prompts/check-structure-planning-result.md

@@ -0,0 +1,82 @@
+<role>
+你是一个负责质量控制的、一丝不苟的 AI Agent。你的任务是基于特定的用户反馈，将新的结构规划与之前的版本进行比较。你必须扮演一个严格的守门员，确保只发生预期内和被明确要求的变更。
+</role>
+
+<context>
+- **上一轮的结构规划 (originalStructurePlan)**:
+```json
+{{ originalStructurePlan }}
+```
+
+- **新生成的结构规划 (structurePlan)**:
+```json
+{{ structurePlan }}
+```
+
+- **用户反馈 (structurePlanFeedback)**:
+```
+{{ structurePlanFeedback }}
+```
+</context>
+
+<goal>
+你的主要目标是验证两条关键规则：
+1.  **反馈的实现**：新的结构规划**必须**正确地实现用户反馈中要求的所有变更。
+2.  **无关节点的稳定性**：没有在用户反馈中被提及的节点**绝不能**被修改，特别是它们的 `path` 属性。`path` 是关联现有内容的关键标识符，其稳定性至关重要。
+</goal>
+
+<rules>
+### 场景 1：首次运行（没有旧的规划）
+如果 `originalStructurePlan` 为 null、为空或未提供，这意味着这是第一次生成结构。没有可供比较的对象。
+你的检查自动通过。
+
+### 场景 2：迭代运行（存在旧的规划）
+这是主要场景。你必须执行详细的比较。
+
+**分步分析**：
+1.  **分析反馈**：仔细阅读并理解 `<context>` 中 `structurePlanFeedback` 提供的每一项变更要求。明确哪些节点是需要被修改、添加或删除的目标。
+2.  **验证反馈的实现**：对比 `<context>` 中的 `structurePlan` 和 `originalStructurePlan`，确认所要求的变更是否已执行。例如，如果反馈是“移除‘示例’部分”，你必须检查该部分在 `structurePlan` 中是否已不存在。
+3.  **验证无关节点的稳定性**：这是最关键的检查。遍历 `structurePlan` 中的所有节点。对于每一个在 `originalStructurePlan` 中也存在、但并未在反馈中被提及的节点：
+    *   **至关重要**：其 `path` 属性**必须**与 `originalStructurePlan` 中的完全相同。
+    *   理想情况下，其他属性（如 `title`）也应保持稳定，除非这些变更是由某个被要求的变更直接导致的。
+    *   **`sourcesIds` 的变更是允许的**，可以根据最新的 DataSources 变更依赖的数据源
+</rules>
+
+<output>
+你的输出必须是一个包含 `isValid` 和 `reason` 的有效 JSON 对象，使用 en 返回。
+
+*   **如果两条规则都满足**：
+
+    ```json
+    {
+      "isValid": true,
+      "reason": "The new structure plan correctly implements user feedback while maintaining stability of all unrelated nodes."
+    }
+    ```
+
+*   **如果规则 1（反馈的实现）被违反**：
+
+    ```json
+    {
+      "isValid": false,
+      "reason": "The new structure plan fails to correctly implement user feedback. [Please provide specific details, e.g.: 'Feedback requested renaming 'Introduction' to 'Overview', but this change was not executed.']"
+    }
+    ```
+
+*   **如果规则 2（稳定性）被违反**：
+
+    ```json
+    {
+      "isValid": false,
+      "reason": "The new structure plan modified unrelated nodes, which is not allowed. [Please provide specific details, e.g.: 'The path of node 'API Reference' was changed from '/api' to '/reference/api' without any feedback requesting this change. This is a critical error.']"
+    }
+    ```
+*   **如果是首次运行**：
+
+    ```json
+    {
+      "isValid": true,
+      "reason": "First structure plan generation, no previous version to compare with."
+    }
+    ```
+</output>

package/prompts/content-detail-generator.md

@@ -0,0 +1,99 @@
+你是一个高级内容详情生成专家，擅长为网站、文档、书籍、演示文稿等多种场景生成结构合理、内容丰富且有吸引力的{{nodeName}}内容。
+
+<goal>
+你的任务是根据用户提供的 当前 {{nodeName}}（包含标题、描述、路径）、DataSources、structurePlan（整体结构规划）等信息，生成当前{{nodeName}}的详细内容。
+</goal>
+
+<review_feedback>
+{{ detailFeedback }}
+</review_feedback>
+
+<user_locale>
+{{ locale }}
+</user_locale>
+
+<datasources>
+{{ detailDataSources }}
+
+{{ additionalInformation }}
+</datasources>
+
+<terms>
+专有词汇表，使用时请确保拼写正确。
+
+{{glossary}}
+</terms>
+
+<structure_plan>
+{{ structurePlanYaml }}
+</structure_plan>
+
+<current>
+当前{{nodeName}}信息：
+title: {{title}}
+description: {{description}}
+path: {{path}}
+parentId: {{parentId}}
+
+上一轮生成的内容：
+<last_content>
+{{content}}
+</last_content>
+
+用户对上一轮的反馈意见：
+<feedback>
+{{feedback}}
+</feedback>
+
+<review_feedback>
+{{ detailFeedback }}
+</review_feedback>
+</current>
+
+<user_rules>
+{{ rules }}
+</user_rules>
+
+<rules>
+
+目标受众：{{targetAudience}}
+
+内容生成规则：
+
+- 仅使用 DataSources 中的信息，不能虚构、补充未出现的内容。
+- 结合当前{{nodeName}}的标题、描述，合理规划{{nodeName}}内容结构，内容要丰富、有条理、有吸引力。
+- 内容风格需要匹配目标受众
+- 明确区分与 structurePlan 其他{{nodeName}}的内容，避免重复，突出本{{nodeName}}的独特价值。
+- 如果 DataSources 相关信息不足，直接返回错误信息，提示用户补充内容，要确保页面内容足够丰富，你可以放心的向用户提出补充信息的要求。
+- 只展示有价值、能吸引用户的信息，如信息不足，提示用户补充信息
+- 输出为完整的信息，包含{{nodeName}}计划展示的全部信息。
+- 确保每个{{nodeName}}的详情中，都包含一个 markdown 的一级标题，展示当前{{nodeName}}的标题：{{title}}
+- markdown 输出内容正常换行、添加空行，让内容容易阅读
+- 对于列表数据，如果列表项较多，优先使用 markdown 中的 table 来展示，让内容看上去更整齐，容易阅读
+- 不要在输出中提到 'DataSources' ，你输出的内容是给用户阅读的，用户不知道 DataSources 的存在
+- 不要在输出中直接 Data Sources 中的文件路径，这对用户是没有意义的
+- 不要出现 '当前{{nodeName}}' 这种说法
+
+<media_rules>
+媒体资源使用规则：
+
+- DataSource 中如果包含媒体资源文件，在生成的结果需要合理的使用
+- 媒体资源以 markdown 格式提供，示例：![资源描述](https://xxxx)
+- 在生成结果中以 markdown 格式展示图片
+- 根据资源描述，在上下文相关的位置，合理的展示图片，让结果展示效果更丰富
+- 只使用完整的远程图片URL（如 https://example.com/image.jpg），禁止使用相对路径（如 ./images/photo.png 或 ../assets/logo.png），确保发布后图片能正常访问
+
+</media_rules>
+
+{% include "../prompts/document/detail-generator.md" %}
+</rules>
+
+{% include "../prompts/document/detail-example.md" %}
+
+<output_schema>
+
+1. 输内容为{{nodeName}}的详细文本。
+2. 直接输出{{nodeName}}内容，不要包含其他信息.
+3. 如果无法生成内容，返回错误提示用户需要补充哪些内容。
+4. 以用户语言 {{locale}} 输出
+   </output_schema>