Interface Specifications

docgraph.toml Configuration

The docgraph.toml file at the project root defines the validation rules and workspace behavior.

Specifications:

• File Path: docgraph.toml (Project Root)
• Format: TOML

Defined by

• FR_CORE_CONFIGURATION (Configuration)

Justified by

• UC_WRITE (Write Specifications)

---

Command Line Interface

The docgraph CLI provides commands for linting, graph generation, and analysis of Markdown documentation.

Defined by

• FR_CLI_LINT (Lint Command)
• FR_CLI_GRAPH (Graph Command)
• FR_CLI_LIST (List Capability)

Justified by

• UC_CLI_ANALYSIS (CLI Traceability Analysis)

---

Interface: Claude Code Plugin

The Docgraph Claude plugin provides a specialized interface for Claude Code, enabling the AI agent to perform complex documentation analysis and manipulation.

The interface acts as a high-level wrapper around the Docgraph core functions, tailored for the agentic capabilities of Claude. It leverages the Model Context Protocol (MCP) to expose tools and resources.

Exposed Capabilities:

The interface MUST expose the following capabilities to the AI agent:

1. Knowledge Extraction: Tools to retrieve the structured graph from Markdown files.
2. Traceability Analysis: Tools to trace dependencies and impacts across the graph.
3. Linting & Fixing: Tools to run validation rules and apply automated fixes.
4. Rule Explanation: Tools to retrieve human-readable descriptions of architectural rules.

Implementation:

The implementation is defined in:

• plugin.json (Plugin Definition)
• SKILL.md (Plugin Skill Definition)

Defined by

• FR_CLAUDE_RAG (Retrieval-Augmented Generation)

Justified by

• UC_AI_ASSISTANCE (AI-Assisted Documentation)

---

Claude Marketplace

The distribution platform for Claude Desktop plugins.

Defined by

• FR_CLAUDE_MARKETPLACE (Claude Marketplace Support)

Justified by

• UC_CLAUDE_INSTALL (Install Claude Plugin)

---

VS Code Marketplace

The distribution platform for Visual Studio Code extensions.

Defined by

• FR_VSC_LSP_CLIENT (LSP Client Integration)

Justified by

• UC_VSCODE_INSTALL (Install VS Code Extension)

---

VS Code UI

The user interface of Visual Studio Code, including commands, views, and settings.

Defined by

• FR_VSC_LSP_CLIENT (LSP Client Integration)

Justified by

• UC_EDITOR_LSP (Editor Support via LSP)

---

GitHub Releases Interface

The system interacts with GitHub Releases to distribute pre-compiled binaries and extension packages.

Specifications:

1. Host: github.com
2. Access: Public anonymous access for downloads.
3. Format: Compressed archives (.tar.gz, .zip) and VSIX packages.

Defined by

• FR_INSTALL_BINARY (Binary Installation Support)

Justified by

• UC_INSTALL_BINARY (Install via Binary Script)

---

Zed UI

The user interface of the Zed editor, including the command palette and settings.

Defined by

• FR_INSTALL_EXT_ZED (Zed Editor Extension)

Justified by

• UC_ZED_INSTALL (Install Zed Extension)