kn-doc

Manage Knowns documentation via a unified CLI for viewing, searching, creating, and updating docs.

234|50|Updated Dec 25, 2025
One-click install
npx skills add https://github.com/knowns-dev/knowns --skill kn-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: kn-doc
Source: https://github.com/knowns-dev/knowns/tree/main/.agent/skills/kn-doc
Command: npx skills add https://github.com/knowns-dev/knowns --skill kn-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of discovering and managing Knowns documentation by providing a unified CLI to view, search, create, and update docs.

Core Features & Use Cases

  • View and search docs across the Knowns workspace.
  • Create docs with required metadata (title, description, tags) and organize in folders.
  • Update content and metadata for existing docs.
  • Use case: quickly locate a pattern doc and update its description to reflect new guidance.

Quick Start

Use the kn-doc skill to list docs with mcp__knowns__list_docs({})

View a doc in smart mode with mcp__knowns__get_doc({ "path": "<path>", "smart": true })

Search docs with mcp__knowns__search_docs({ "query": "<query>" })

Create a doc with mcp__knowns__create_doc({ "title": "<title>", "description": "<brief description>", "tags": ["tag1","tag2"], "folder": "guides" })

Update content with mcp__knowns__update_doc({ "path": "<path>", "content": "new content" })

Update metadata with mcp__knowns__update_doc({ "path": "<path>", "title": "New Title", "description": "Updated description", "tags": ["new","tags"] })

Validate after changes with mcp__knowns__validate({ "scope": "docs" })

Frequently Asked Questions about kn-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I search for existing documentation across the workspace?

To search documentation across the workspace, use the search_docs operation with a query string. This returns matching documents from core docs, guides, and patterns, enabling quick discovery of relevant content within the Knowns environment.

Can I create new documentation with required metadata using the CLI?

Yes, you can create documentation using the CLI by providing required metadata fields including title, description, and tags, along with a target folder for organization. This ensures new docs are properly structured and discoverable within the Knowns workspace.

What's the best way to update both content and metadata for a doc?

The best way to update documentation is using the update_doc operation, which accepts a path parameter to target the doc and allows modifying content, title, description, and tags simultaneously to keep records current during development cycles.

Does the documentation CLI support validation after updates?

Yes, the documentation CLI supports validation after updates through the validate operation with a scope parameter. This verifies that changes to docs maintain required standards and consistency across the Knowns workspace.

How do I list all available docs in the Knowns workspace?

To list all available docs in the Knowns workspace, use the list_docs operation without parameters. This retrieves a comprehensive index of documentation, including core docs, guides, and patterns, for easy navigation and management.

Can I view a specific document in smart mode through the CLI?

Yes, you can view a specific document in smart mode by using the get_doc operation with the document path and enabling the smart parameter. This provides an optimized view of the documentation content for better readability.