AGENT SKILL

sw-kb-api

Query the SolidWorks knowledge-base catalog for categories, matching parts, complete published instructions, macros, known API errors, and lessons. Use after sw-pre-start and before any SolidWorks modeling or API work, for every part, assembly, drawing, repair, or model reproduction request.

适用职业开发工程师
使用场景后端与接口
License 许可
Apache-2.0
最近更新
2026-11-14
Stars
★ 1.6k
Forks
491

01 前言 Front Matter

name
sw-kb-api
description
Query the SolidWorks knowledge-base catalog for categories, matching parts, complete published instructions, macros, known API errors, and lessons. Use after sw-pre-start and before any SolidWorks modeling or API work, for every part, assembly, drawing, repair, or model reproduction request.

02 资源文件 1

03 SKILL.md 正文

SolidWorks KB Lookup

Run $sw-pre-start first. Complete this lookup before CAD work.

Set KB_HOST from SW_KB_HOST; default to https://sw-plugin.ideep.org. Use quoted curl shell calls only. Runtime endpoints are public and use camelCase JSON.

On Windows, run curl.exe instead of curl: in Windows PowerShell 5.1 curl is an alias for Invoke-WebRequest, which rejects curl options such as -sS. curl.exe is the real curl in every Windows shell.

1. Check health

curl -sS "{KB_HOST}/health"

If unreachable, tell the user Knowledge base is offline - proceeding without KB lookup, record the outage for session feedback, and continue from verified engineering knowledge. Do not abort the CAD task.

2. Match a category

curl -sS "{KB_HOST}/api/categories"

Fuzzy-match the requested component against category name or slug. Save the matching id as categoryId. If nothing matches, continue to the free-text fallback in Step 4.

3. Match a part inside the category

curl -sS "{KB_HOST}/api/parts?categoryId={categoryId}&pageSize=100"

Optionally add a URL-encoded q parameter. Match active items by exact or close partNumber, then by name. Save the best id as partId.

4. Load complete part detail

When partId is known:

curl -sS "{KB_HOST}/api/parts/{partId}"

Otherwise search globally:

curl -sS "{KB_HOST}/api/parts?q={encoded-name-or-number}&pageSize=20"

Fetch the best match's detail. Read every published instructions, macros, knownErrors, and lessons item rather than relying on list summaries.

5. Apply the result

For a part with instructions:

  • follow published instructions as the primary build guide;
  • use a complete isTemplate: false macro directly after replacing only declared parameters with user values;
  • adapt an isTemplate: true macro to the current part;
  • read all known errors before using any listed swFeature and apply resolved fixes proactively;
  • treat every lesson prevention as an active constraint;
  • tell the user which part was found and how many macros are being used.

For a catalog part without instructions, apply its errors and lessons, explain that no published build guide exists, and build from verified knowledge.

When no part matches, explain that the part is not yet in the KB, load the global safeguards below, and build from scratch. Do not promise that feedback will be sent; submission still requires consent.

6. Load global safeguards

Always run both calls, even if no part matched:

curl -sS "{KB_HOST}/api/errors"
curl -sS "{KB_HOST}/api/lessons"

Before every SolidWorks API call, cross-reference the method against global and part-specific errors. When isResolved is true, apply resolution before the call. Apply lesson prevention fields as rules, prioritizing critical and high severity.

Cache and failures

Cache categories and global errors or lessons once per Codex task. Cache each part detail once per build. Refresh only when the user explicitly requests it or the task changes to a different part.

  • 200: use the data.
  • 404: treat the resource as absent and continue.
  • 422: correct or simplify the query, then try the free-text fallback once.
  • 5xx or timeout: record the outage and continue without KB data.

04 同仓库更多 Skills

hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-review-with-annotations

Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-find-and-synthesize-context

Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-update-docs

Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-manage-records

Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-manage-interactive-html

Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-collaborate-threads

Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.

★ 1.6k