Agent Skills › langchain-ai/openwiki › write-connector

write-connector

GitHub

指导在OpenWiki仓库中开发内置TypeScript连接器，涵盖文件结构、安全规范及数据摄取规则。需确保密钥安全、路径校验及状态持久化，并在完成后告知用户配置变更与运行步骤。

skills/write-connector/SKILL.md langchain-ai/openwiki

触发场景

创建新的OpenWiki连接器实现OpenWiki数据源连接

安装

npx skills add langchain-ai/openwiki --skill write-connector -g -y

更多选项

不安装直接使用

npx skills use langchain-ai/openwiki@write-connector

指定 Agent (Claude Code)

npx skills add langchain-ai/openwiki --skill write-connector -a claude-code -g -y

安装 repo 全部 skill

npx skills add langchain-ai/openwiki --all -g -y

预览 repo 内 skill

npx skills add langchain-ai/openwiki --list

SKILL.md

Frontmatter

{
    "name": "write-connector",
    "description": "Add a new built-in OpenWiki source connector. Use when a user asks to create or implement an OpenWiki connector."
}

Write An OpenWiki Connector

OpenWiki connectors are built-in TypeScript modules in the OSS repository. Do not create a plugin marketplace, dynamic connector package, or runtime-loaded untrusted connector. Add normal source files and tests.

Required Shape

Add the connector to src/connectors/types.ts and src/connectors/registry.ts.
Implement the connector under src/connectors/sources/.ts.
The connector must expose a ConnectorRuntime with id, displayName, description, backend, requiredEnv, supportsAgenticDiscovery, and ingest().
Ingestion writes raw JSON/manifests under ~/.openwiki/connectors//raw//.
State lives in ~/.openwiki/connectors//state.json.
Config lives in ~/.openwiki/connectors//config.json.
Secrets live in ~/.openwiki/.env and are referenced only by env var name.

Security Rules

Never read, print, log, return, or hardcode secret values.
Do not store credentials in connector config, raw files, state, logs, or tests.
Validate connector IDs and raw file paths so reads and writes stay inside ~/.openwiki/connectors//.
Use deterministic ingestion code for credentialed external fetching.
If wrapping MCP, treat the MCP server as read-only and call only allowlisted read/dump operations from connector config.
Do not let untrusted connector manifests instantiate arbitrary commands or arbitrary network endpoints without explicit built-in code review.

Ingestion Rules

Git/local repos should write compact manifests and let the agent inspect the local repo as the source of truth.
Sources with timestamps should store per-stream cursors.
Sources with object metadata should store IDs, last edited timestamps, and content hashes.
Sources with pagination should store enough state to continue without refetching everything.
Raw dumps should preserve source IDs, timestamps, URLs, authors, and enough provenance for citations.