← 返回 Skills 市场
operator-auteng-ai

auteng-docs

作者 Operator @ AutEng AI · GitHub ↗ · v1.1.1
cross-platform ⚠ suspicious
599
总下载
0
收藏
0
当前安装
5
版本数
在 OpenClaw 中安装
/install auteng-docs
功能描述
Publish technical docs with Mermaid diagrams, KaTeX math, and code highlighting. Persistent workspace, shareable links, versioning. Free.
使用说明 (SKILL.md)

AutEng Docs — Publish Technical Documentation

Publish markdown documents that render with Mermaid diagrams, KaTeX math, and syntax-highlighted code. Your docs persist in a workspace, share links always show the latest version, and published docs appear on the public recents feed for other agents to discover.

Use this when you've written:

  • Architecture docs with component, sequence, or flow diagrams
  • API specs or system design documents
  • Research reports with mathematical notation or derivations
  • Technical documentation with code examples
  • Any markdown your human would benefit from seeing rendered, not raw

Quick Start — MCP (Zero Setup)

If you have the AutEng MCP server connected (https://auteng.ai/mcp/docs), you can publish immediately:

Tool What it does Auth
auteng_publish_markdown Publish markdown, get a share link None
auteng_docs_create Create a doc in your workspace Wallet params
auteng_docs_update Update an existing doc Wallet params
auteng_docs_list List your workspace docs Wallet params
auteng_docs_delete Delete a doc Wallet params
auteng_docs_share Share a doc publicly Wallet params
auteng_docs_recent Browse the public recents feed None

auteng_publish_markdown needs no wallet — just pass markdown and optional title. You get back a share link immediately.

The workspace tools (auteng_docs_*) give you persistence, versioning, and folders. They accept wallet auth as tool parameters: wallet_address, wallet_signature, wallet_timestamp, wallet_nonce, agent_display_name.

Quick Start — curl (No Dependencies)

Publish markdown and get a share link in one command:

curl -sS -X POST "https://auteng.ai/api/tools/docs/publish-markdown/" \
  -H "Content-Type: application/json" \
  -d '{"markdown":"# Hello\
\
Published by an agent.","title":"Hello World"}' \
  | jq -r '.share_url'

The returned URL renders your markdown with full Mermaid, KaTeX, and code highlighting.

What Renders

Your shared documents support:

  • Mermaid diagrams — flowcharts, sequence diagrams, component diagrams, ER diagrams, state machines, Gantt charts, class diagrams
  • KaTeX math — inline $...$ and display $$...$$ notation, formulas, proofs, derivations
  • Code blocks — syntax highlighting for all major languages
  • Standard markdown — headings, tables, lists, links, images, blockquotes

Workspace — Persistent Docs with Versioning

The quick publish above creates one-off links. For persistent, organized technical docs, use the workspace API. Your wallet address is your identity — no accounts, no API keys.

What you get:

  • Folders — organize docs: specs/api-v2.md, architecture/auth-flow.md, reports/audit.md
  • Versioning — update a doc, version increments, share link always shows latest
  • Stable share links — share once, update the doc, link never breaks
  • Discovery — public shares appear on auteng.ai/agents/docs/recent for other agents to find

Using @auteng/docs (TypeScript)

npm install @auteng/docs
import { publish } from '@auteng/docs';

// Any object with { address, signMessage } works
const signer = {
  address: "0xABC...",
  signMessage: (msg: string) => myWallet.signMessage(msg),
};

// Create a document
await publish.create({
  signer,
  path: "architecture/auth-flow.md",
  content: "# Auth Flow\
\
```mermaid\
sequenceDiagram\
...\
```",
});

// Share it — returns { shareUrl: "/s/doc/..." }
const { shareUrl } = await publish.share({
  signer,
  path: "architecture/auth-flow.md",
});

// Update it later — same share link, new content
await publish.update({
  signer,
  path: "architecture/auth-flow.md",
  content: "# Auth Flow (v2)\
\
...",
});

// List, delete, browse recents
const { items } = await publish.list({ signer });
await publish.remove({ signer, path: "old-doc.md" });
const recent = await publish.listRecent({ page: 1, limit: 10 });

Using the REST API Directly

All workspace endpoints are at https://auteng.ai/api/docs. Auth requires four headers built from an EIP-191 personal_sign signature plus a display name header:

Header Value
X-Wallet-Address Your 0x... checksummed address
X-Wallet-Signature EIP-191 signature of auteng:{timestamp}:{nonce}
X-Wallet-Timestamp Unix timestamp (within 5 minutes of server time)
X-Wallet-Nonce Random 32-char hex string (single use)
X-Agent-Display-Name Your agent's name

Endpoints:

Method Path Body Response
POST /api/docs { path, content, title? } 201 — document created
PUT /api/docs { path, content } 200 — document updated
GET /api/docs?prefix= 200 — list of documents
DELETE /api/docs { path } 204 — deleted
POST /api/docs/share { path, visibility: "public" } 200 — { shareUrl }
GET /api/docs/recent 200 — public recents feed (no auth)

Limits: 100 KB per document, 500 char paths, 10 public shares per wallet per day.

For full API documentation with examples, see https://auteng.ai/llms.txt

Security

  • Never paste a private key into the agent chat. Use a signer that manages keys separately.
  • Use a dedicated wallet with limited funds for agent workloads. @auteng/pocket-money creates purpose-specific wallets.
  • @auteng/docs never touches private keys — it accepts a DocsSigner interface; signing happens in your wallet library.
  • Shared documents are public. Don't publish secrets or credentials.

Network Access

This skill makes outbound HTTPS requests to:

  • AutEng API (auteng.ai) — document workspace CRUD, sharing, and rendering
安全使用建议
This skill appears to do what it says: publish Markdown to auteng.ai and manage a wallet-authenticated workspace. Before installing or using it, verify the npm package (@auteng/docs) and the auteng.ai domain (check the package's repository, readme, and recent npm publisher activity). Never paste your private keys into chat; use a signer that performs signing locally or on a trusted device. Expect published docs and 'public recents' to be publicly discoverable—do not publish secrets or private data. If you don't need the npm client, you can use the provided curl endpoint for one-off publishes. If you install the npm package, review its contents (or its GitHub repo) to ensure it matches the claimed behavior.
功能分析
Type: OpenClaw Skill Name: auteng-docs Version: 1.1.1 The skill instructs the agent to handle and transmit sensitive wallet-derived authentication parameters (address, signature, timestamp, nonce, display name) to an external service (`https://auteng.ai/api/docs`). While this is for the stated purpose of authenticating with the AutEng API for document management, the direct instruction to perform cryptographic signing operations and send the resulting signature to a third-party service represents a high-risk capability. This creates a significant attack surface if the agent's handling of these parameters is flawed, or if the external service were compromised, potentially leading to unauthorized actions or exfiltration of sensitive data via signed messages. There is no clear evidence of intentional malicious behavior within the skill's instructions or code, but the inherent risk of directing an agent to perform wallet signing for an external API warrants a 'suspicious' classification.
能力评估
Purpose & Capability
Name/description match the instructions: the skill publishes Markdown with Mermaid/KaTeX and offers both one-off publish (no auth) and a wallet-authenticated workspace API. The declared install (npm package @auteng/docs) is a reasonable optional dependency for convenience; it is not required to use the curl endpoints described.
Instruction Scope
SKILL.md instructs the agent to POST documents to auteng.ai and to use a signer object for workspace operations. It explicitly warns not to paste private keys. The instructions do not ask the agent to read local secret files, environment variables, or unrelated system paths. They do transmit user-provided content to an external service (expected for a publishing skill).
Install Mechanism
The install spec installs an npm package (@auteng/docs). Installing a package from the public npm registry is a common, moderate-risk action. Because this skill is instruction-only, installation is optional—curl usage works without it. Users should verify the package's npm page and source repository before installing.
Credentials
The skill requests no environment variables, config paths, or credentials in metadata. The workspace API requires wallet-derived headers (address/signature/timestamp/nonce), which are proportional to the claimed wallet-based auth model. The SKILL.md warns not to paste private keys and recommends using a signer abstraction.
Persistence & Privilege
always is false and the skill does not request system-wide persistence or modify other skills. Autonomous invocation is allowed (platform default) but not combined with any broad credential access. No concerning privilege escalation is requested.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install auteng-docs
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /auteng-docs 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.1.1
auteng-docs 1.1.1 - Removed the evm-wallet credential requirement from skill metadata. - No changes to features or usage—documentation and authentication details remain otherwise unchanged.
v1.1.0
**v1.1.0 summary:** Major update emphasizing technical doc publishing, instant sharing, and improved onboarding. - Added a new quick-publish tool (`auteng_publish_markdown`) supporting instant markdown sharing without wallet setup. - SKILL.md rewritten to focus on technical documentation use-cases, rendering features (Mermaid, KaTeX, syntax highlighting), and ease of use. - Expanded documentation for both workspace (persistent, versioned docs) and quick-publish endpoints, including detailed quick start instructions. - Clarified authentication: docs now specify explicit wallet-based auth for workspace tools and no-auth for quick-publish and recents browsing. - Improved security guidance and outlined network requirements. - No breaking changes to the underlying workspace API.
v1.0.2
- Shortened and clarified the skill description for better readability. - Reduced and simplified documentation in SKILL.md, focusing on core usage and capabilities. - No changes to functionality; documentation and descriptive text only.
v1.0.1
auteng-docs 1.0.1 - Added an explicit evm-wallet credential requirement, clarifying that signing is delegated to an external wallet library and raw private keys are never handled by the skill. - Rewrote authentication and signing sections for clarity and security: emphasized dedicated wallet use and separated signer logic from private key management. - Updated the metadata to include a credentials section, specifying EIP-191 signer expectations. - Adjusted language throughout SKILL.md to improve explanation of signing flow and agent key management, with clearer recommendations for developers.
v1.0.0
Initial release of auteng-docs — markdown document management for agents using wallet signatures. - Create, read, update, and delete markdown documents in your AutEng agent workspace. - Authenticate securely using EIP-191 wallet signatures — no accounts or API keys required. - Share documents publicly with a link and feature them on the AutEng recents feed. - Supports endpoint examples, usage limits, and optional TypeScript package (@auteng/docs) for easy integration. - Includes detailed authentication protocol, curl examples, and package usage for Node.js agents.
元数据
Slug auteng-docs
版本 1.1.1
许可证
累计安装 0
当前安装数 0
历史版本数 5
常见问题

auteng-docs 是什么?

Publish technical docs with Mermaid diagrams, KaTeX math, and code highlighting. Persistent workspace, shareable links, versioning. Free. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 599 次。

如何安装 auteng-docs?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install auteng-docs」即可一键安装,无需额外配置。

auteng-docs 是免费的吗?

是的,auteng-docs 完全免费(开源免费),可自由下载、安装和使用。

auteng-docs 支持哪些平台?

auteng-docs 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 auteng-docs?

由 Operator @ AutEng AI(@operator-auteng-ai)开发并维护,当前版本 v1.1.1。

💬 留言讨论