@wxg-prc-cpg/dsh-weknora

A DeepSeek Harness (dsh) plugin that gives the harness agent first-class access to a WeKnora knowledge base: hybrid retrieval, full document reading, and WeKnora's own composed answers with citations.

dsh ships no retrieval, embedding or knowledge-base capability of its own — its search tools (grep, glob) read the workspace, and web_search reads the internet. This plugin fills that gap with your organization's documents.

Install

# from npm (recommended: installs prebuilt code, no build permission needed)
dsh plugin --profile web add @wxg-prc-cpg/dsh-weknora

# or from a checkout of this repository
dsh plugin --profile web add ./packages/dsh-weknora

Then point it at your deployment. The shipped configuration layer reads environment variables, so the quickest start is:

export WEKNORA_BASE_URL=https://weknora.example.com   # or http://localhost:8080
export WEKNORA_API_KEY=sk-...                          # a WeKnora API key with `retrieve` (+ `chat` for ask)
export WEKNORA_KNOWLEDGE_BASE_IDS=kb-123,kb-456        # optional default scope
dsh web

For anything beyond that, override the row from your profile's cordis.patch.yml ($DSH_HOME/profiles//cordis.patch.yml):

- id: weknora
  config:
    baseUrl: https://weknora.example.com
    apiKey: !!js process.env.WEKNORA_API_KEY
    knowledgeBaseIds:
      - kb-product-docs
    agentId: ''            # a WeKnora custom agent id makes `weknora_ask` use the ReAct pipeline
    maxResults: 8
    maxChunkChars: 1200
    requestTimeoutMs: 30000
    chatTimeoutMs: 300000
    resourceUrls: handle   # `public` asks WeKnora for directly loadable file URLs in citations
    toolPrefix: weknora    # rename the tools, e.g. to mount two deployments side by side
    tools:
      listKnowledgeBases: true
      search: true
      readDocument: true
      ask: true

A patch replaces the row's whole config, so restate every field you keep. Invalid configuration fails the plugin load with a message naming each violation, rather than failing inside the first tool call.

Tool	WeKnora endpoint	What the model gets
`weknora_list_knowledge_bases`	`GET /knowledge-bases`	Knowledge base names and ids, to report what exists or to narrow a later search
`weknora_search`	`POST /knowledge-search` + `GET /knowledge/search`	Ranked passages verbatim, each with a `knowledge_id`, score and chunk index, plus any document the query names
`weknora_read_document`	`GET /chunks/:knowledge_id` + `GET /knowledge/:id`	One document's passages reassembled in order, led by its title and summary, with paging
`weknora_ask`	`POST /sessions` + `POST /knowledge-chat/:id` or `POST /agent-chat/:id`	WeKnora's own answer, its citations, the server-side tools it used, and a resumable `session_id`

Field	Default	Notes
`baseUrl`	`http://localhost:8080/api/v1`	`/api/v1` is appended when missing
`apiKey`	unset	`X-API-Key`; unset means an unauthenticated deployment
`tenantId`	unset	`X-Tenant-ID`, required for platform-scoped keys
`knowledgeBaseIds`	`[]`	Default scope when a call names none; empty means every knowledge base the credential can see
`agentId`	unset	Sends `weknora_ask` to the ReAct pipeline
`maxResults`	`8`	Also the ceiling for `max_results` and for cited references
`maxChunkChars`	`1200`	Per-passage character budget
`requestTimeoutMs`	`30000`	Retrieval and document reads
`chatTimeoutMs`	`300000`	`weknora_ask`, which waits on WeKnora's own model calls
`resourceUrls`	`handle`	`public` returns directly loadable file URLs
`toolPrefix`	`weknora`	Tool-name prefix, `^[a-z][a-z0-9_]*$`
`tools.*`	all `true`	Register fewer tools to spend fewer prompt tokens

@wxg-prc-cpg/dsh-weknora

安装

说明文档

@wxg-prc-cpg/dsh-weknora

Install

Tools

Permissions and data flow

Configuration reference

Development

Compatibility

License