API Reference¶
Auto-generated reference for the public Python API of the LCP SDK, extracted directly from the source docstrings. For conceptual explanations of how each component works, see the Architecture section.
Modules¶
| Module | Description |
|---|---|
| Scanner | Introspects an installed Python package into ScannedModule |
| Generator | Converts scanned data into an LCPDocument |
| Validator | Validates documents against the LCP JSON Schema |
| Models | Pydantic models matching the LCP v1 specification |
| Coverage | Measures documentation completeness across a package |
| Diff | Compares two LCP manifests and detects deprecations |
| Publish | Submits manifests to the registry via GitHub Pull Request |
| MCP Server | Serves LCP manifests to AI agents over the Model Context Protocol |
| AI DocGen | Optional LLM-based docstring generation (lcp[ai]) |
Top-level entry point
Most workflows start from the package-level scan() function, re-exported from lcp. See Scanner for the full pipeline.