Write Connector
Add a new built-in OpenWiki source connector.
Install
npx skills add langchain-ai/openwiki --skill write-connector -g -a claude-code -y- Repository
- langchain-ai/openwiki17.7k
- Category
- Engineering
- Updated
- 3d ago
- License
- MIT
- Context cost
- Lightabout 775 tokens
- Runs scripts
- No, instructions only
What it does
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.
Prefer Custom MCP For Arbitrary Servers
If the knowledge source already exposes a read-only MCP server (HTTP or stdio), use the built-in custom-mcp connector instead of adding a new ConnectorId:
- Configure
~/.openwiki/connectors/custom-mcp/config.jsonwithenabled,transport, optionalallowedTools, and optionalreadOnlyOperations. - Put secrets in
~/.openwiki/.envand reference them as${ENV_NAME}in transport headers/env. - Agent tools
openwiki_list_mcp_tools/openwiki_call_mcp_toolacceptcustom-mcp.
Add a dedicated built-in connector only when you need provider-specific auth, scoping UI, or deterministic API pulls that MCP cannot express.
Required Shape
- Add the connector to src/connectors/types.ts and src/connectors/registry.ts.
- Implement the connector under src/connectors/sources/<connector>.ts.
- The connector must expose a ConnectorRuntime with id, displayName, description, backend, requiredEnv, supportsAgenticDiscovery, and ingest().
- Ingestion writes raw JSON/manifests under ~/.openwiki/connectors/<id>/raw/<run-id>/.
- State lives in ~/.openwiki/connectors/<id>/state.json.
- Config lives in ~/.openwiki/connectors/<id>/config.json.
- Secrets live in ~/.openwiki/.env and are referenced only by env var name.
