LSP_SPEC.md¶

Document status: future target design

Do not use this page for integration. For what ships today, read lsp-api.md (authoritative for v0.13). Implemented: hover, document/workspace symbols, go-to-definition, diagnostics publishing, strixonomy/indexWorkspace, strixonomy/getCatalogSnapshot, strixonomy/getEntity, strixonomy/applyAxiomPatch, strixonomy/query, strixonomy/sparql, strixonomy/parseManchester, strixonomy/runReasoner, strixonomy/getExplanation. See handlers.rs on GitHub and protocol.rs on GitHub.

1. Purpose¶

The Strixonomy language server provides ontology-aware editor features to Strixonomy and potentially other editors.

2. Transport¶

• stdio for VS Code (shipped)
• optional TCP for debugging (not implemented — if added, must bind 127.0.0.1 only and require explicit opt-in; never expose unauthenticated LSP on a public interface; see security.md)

3. Supported File Types¶

• Turtle
• RDF/XML
• OWL/XML
• JSON-LD
• OBO
• N-Triples
• TriG

4. Required LSP Capabilities¶

Sections below describe the target capability set. Implementation status is noted where v0.2 differs.

4.1 Diagnostics¶

v0.3 (shipped): parse errors, broken imports, undefined prefixes, duplicate/missing labels, orphan classes — via textDocument/publishDiagnostics and CatalogSnapshot.diagnostics. Deferred to later milestones: missing comments, deprecated usage, invalid domain/range.

Sources (DEPENDENCY_MATRIX.md):

• Parse errors — oxigraph via strixonomy-parser
• Import / prefix / quality rules — in-house strixonomy-diagnostics on catalog (duplicate labels, orphans, broken imports, undefined prefixes)
• OBO (v0.7b) — fastobo-validator violations mapped to LSP
• SHACL (v1.0 P1) — rudof via plugin adapter

Diagnostics include:

• parse errors
• undefined prefixes
• broken imports
• duplicate labels
• missing labels
• missing comments
• deprecated usage
• invalid domain/range reference

4.2 Hover¶

v0.2: partial — basic entity information.

Hover should show:

• entity IRI
• label
• comment
• type
• source ontology
• deprecation status
• parent classes
• usages count

4.3 Completion¶

v0.2: not implemented.

Completion contexts:

• prefixes
• IRIs
• known classes
• known properties
• annotation properties
• imported entities

4.4 Go to Definition¶

v0.2: implemented.

For entity references, jump to source declaration.

4.5 Find References¶

Return all entity usages across workspace.

4.6 Rename¶

Safe IRI rename across workspace.

Requirements:

• preview edits
• update imports if needed
• update annotations and axioms
• avoid string-only false positives

4.7 Code Actions¶

Examples:

• add missing label
• add missing comment
• resolve prefix
• create missing import
• mark deprecated usage
• replace deprecated entity

4.8 Document Symbols¶

Expose ontology entities as symbols.

4.9 Workspace Symbols¶

Global entity search.

5. Custom LSP Methods¶

strixonomy/indexWorkspace¶

Indexes the workspace.

strixonomy/getCatalogSnapshot¶

Returns documents, entities, class hierarchy, and diagnostics for UI clients.

strixonomy/query¶

Runs SQL-style query against the indexed workspace catalog (implemented v0.5).

strixonomy/sparql¶

Runs SPARQL query against the indexed catalog (implemented v0.5).

strixonomy/getEntity¶

Returns entity details.

strixonomy/getGraph¶

Returns graph data for visualization.

strixonomy/getSemanticDiff¶

Returns semantic diff between two refs or catalogs.

strixonomy/runReasoner¶

Runs configured reasoner.

strixonomy/applyAxiomPatch¶

Apply a Horned-OWL axiom patch to a document. Used by quick forms and Manchester editor. See OWL_AUTHORING_SPEC.md.

Params: document URI, axiom patch (JSON), preview-only flag.

strixonomy/parseManchester¶

Parse Manchester OWL Syntax expression; return diagnostics and normalized form.

strixonomy/getExplanation¶

Return justification chain for unsatisfiable class. See REASONER_SPEC.md.

strixonomy/runRobot¶

Run ROBOT subcommand (validate, merge, report). See OBO_ROBOT_SPEC.md.

6. Error Handling¶

All custom methods must return structured errors with:

• code
• message
• recoverable
• user_action