feat(lsp): add missing LspServerConfig model fields #1064
No reviewers
Labels
No labels
auto/needs-reevaluation
controller-managed
auto/blocked-by-deps
auto/ci-timeout
auto/claimed-implementer
auto/claimed-merge
auto/claimed-reviewer
auto/driver-down
auto/invariant-violation
auto/last-attempt-tier-0
auto/last-attempt-tier-1
auto/last-attempt-tier-2
auto/last-attempt-tier-min
Automation Tracking
auto/needs-conflict-resolution
auto/needs-implementer
auto/postmortem
auto/ready-to-merge
auto/restart-throttled
auto/revert
auto/sentinel
auto/stale-inactivity
auto/unstable
Blocked
Bounty
$100
Bounty
$1000
Bounty
$10000
Bounty
$20
Bounty
$2000
Bounty
$250
Bounty
$50
Bounty
$500
Bounty
$5000
Bounty
$750
MoSCoW
Could have
MoSCoW
Must have
MoSCoW
Should have
Needs Feedback
Points
1
Points
13
Points
2
Points
21
Points
3
Points
34
Points
5
Points
55
Points
8
Points
88
Priority
Backlog
Priority
CI Blocker
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
State
Completed
State
Duplicate
State
In Progress
State
In Review
State
Paused
State
Unverified
State
Verified
State
Wont Do
Type
Automation
Type
Bug
Type
Discussion
Type
Documentation
Type
Epic
Type
Feature
Type
Legendary
Type
Refactor
Type
Support
Type
Task
Type
Testing
No project
No assignees
3 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
cleveragents/cleveragents-core!1064
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "feature/lsp-config-fields"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
Add specification-required fields to
LspServerConfigper issue #835.New fields
descriptionstr(max 1000)""transportLspTransportenumstdioinitializationdict[str, Any]{}initializationOptionsfor initialize handshakeworkspace_settingsdict[str, Any]{}workspace/didChangeConfigurationNew types
LspTransport(StrEnum)with membersSTDIO,TCP,PIPEBackward compatibility
All new fields have defaults. Existing configs without these fields continue to work unchanged.
Quality Gates
nox -s typechecknox -s lintCloses #835
Day 43 Review — Rebase Required
This PR has merge conflicts with
masterand cannot be merged in its current state. This is one of 9 Hamza PRs in the resource/LSP domain (v3.5.0-v3.6.0) that all have conflicts. These PRs likely share a common dependency chain and should be rebased sequentially.@hamza.khyari: Please rebase onto current
master. If multiple PRs depend on each other, start with the base PR in the chain and work upward.Rebase priority: HIGH — these PRs represent significant feature work that is blocked by merge conflicts. Every day they remain conflicted is a day they cannot be reviewed or merged.
PR Review: !1064 (Ticket #835)
Verdict: Request Changes
This PR adds the four specification-required fields (
description,transport,initialization,workspace_settings) toLspServerConfigwith appropriate defaults for backward compatibility. The core model implementation is clean and correct. However, there is a critical spec deviation (thepipetransport value is not in the specification), two subtasks are marked complete without corresponding code changes (actor YAML schema and registry validation), and the model docstring falsely claims${ENV_VAR}interpolation support that doesn't exist. The PR also has unresolved merge conflicts (already flagged by @freemo).Critical Issues
1.
LspTransportenum includespipe— violates specificationsrc/cleveragents/lsp/models.py, line 43LspTransportenum defines three members:STDIO,TCP,PIPE. The specification (docs/specification.md, line 20551) explicitly states: "Communication transport:stdio(default) ortcp." — only two values. Thepipevalue does not appear anywhere in the spec. Per CONTRIBUTING.md: "When there is a discrepancy between the current codebase and this document [specification], always assume the specification is correct."PIPE = "pipe"fromLspTransport. Ifpipeis genuinely needed, the specification must be updated first (via ADR process). Update the Field description on thetransportfield and all test references accordingly.Major Issues
2. Actor YAML schema subtask marked complete without code changes
src/cleveragents/actor/schema.py— zero changes in this PRNodeLspBindingclass inschema.pywas not modified. If the subtask was intended to be satisfied by the Pydantic model update (sinceLspServerConfig(**raw)naturally accepts new fields from YAML), the subtask wording is misleading. If it requires actual changes toNodeLspBinding, they are missing.3. Registry validation subtask marked complete without code changes
src/cleveragents/lsp/registry.py— zero changes in this PRregistry.pyhas zero changes. Theregister()method performs no validation oftransport,description,initialization, orworkspace_settings. While Pydantic model construction handles type validation, the ticket explicitly calls for registry-level validation.registry.register()for the new fields, or document that validation is fully delegated to Pydantic and update the subtask/criterion wording.4.
${ENV_VAR}interpolation documented but not implementedsrc/cleveragents/lsp/models.py, lines 75–77 (docstring) and lines 119–122 (Field description)LspServerConfigdocstring and theinitializationField description claim "Supports${ENV_VAR}interpolation at runtime." However, no interpolation code exists in the LSP loading path. The CLI command atlsp.py:148does a plainyaml.safe_load()→LspServerConfig(**raw)with no interpolation step. This creates a false contract — users may place${API_KEY}in their initialization dict expecting resolution, but it will be stored literally. This is also a security concern: when someone eventually implements this interpolation, the current documentation provides no security guidance about env var scope.5. PR has merge conflicts — not mergeable (already flagged by @freemo)
mergeable: false. @freemo's comment on 2026-03-23 confirmed merge conflicts and requested a rebase. This remains unresolved.masterand resolve conflicts.Minor Issues
6. CHANGELOG says "18 Behave BDD scenarios" but there are 17
CHANGELOG.md, diff line ~87. Weak validation error assertions in tests
features/steps/lsp_config_fields_steps.py, lines 122–124a validation error should be raised for configonly assertscontext.cfg_error is not None. It does not verify the error is aValidationError(from Pydantic). Any exception type (e.g.,TypeError,KeyError) would also pass. The project convention (used inlsp_registry_steps.py,a2a_facade_steps.py,acms_pipeline_steps.py, etc.) is to useisinstancechecks for the specific exception type.assert isinstance(context.cfg_error, ValidationError).8. Missing boundary pass-case test for description max length
features/lsp_config_fields.feature, near line 279. No negative type-validation tests for
initializationandworkspace_settingsfeatures/lsp_config_fields.featureinitializationandworkspace_settings(e.g., passing a string or integer). Since these fields come from user-supplied YAML, this is an important validation boundary.10. Robot Framework tests lack integration-level value
robot/lsp_config_fields.robot,robot/helper_lsp_config_fields.pyagents lsp add --config <file>command.11. PR quality gates table is incomplete
typecheck,lint, new tests, and existing LSP tests. Per project standards,unit_tests,integration_tests, andcoverage_reportresults should also be listed.12.
agents lsp showRich output omits new fieldssrc/cleveragents/cli/commands/lsp.py, lines 319–327agents lsp showdoes not displaydescription,transport,initialization, orworkspace_settings. Users using the default format will not see these new fields. (JSON/YAML output is unaffected since it usesto_dict().)showcommand. At minimum,transportanddescriptionshould be displayed.Nits
13.
__init__.pyusage example doesn't includeLspTransportsrc/cleveragents/lsp/__init__.py, lines 17–24LspTransport, which is now a public export in__all__.LspTransportto the usage example.14. Inline
import jsoninside step function bodiesfeatures/steps/lsp_config_fields_steps.py, lines 60 and 68import jsonappears inside two function bodies rather than at the module top. The dominant project pattern (91 of 96 files) uses module-level imports.import jsonto the top of the file.15. First BDD scenario starts with
ThenwithoutGiven/Whenfeatures/lsp_config_fields.feature, lines 8–11Then— noGivenorWhencontext. BDD best practice requires a complete Given/When/Then structure.Givenclause to establish context (e.g., "Given the LspTransport enum is defined").16. Dict field assertions only check key existence, not value correctness
features/steps/lsp_config_fields_steps.py, lines 153–157 and 165–169{"python": None}would pass.17. Serialization round-trip test doesn't verify all model fields
features/steps/lsp_config_fields_steps.py, lines 189–197name,description,transport,initialization,workspace_settings, andcapabilitiesbut omitscommand,args,languages, andenv.assert original == deserialized) or check all fields explicitly.Summary
The core implementation is solid — the four new
LspServerConfigfields are correctly defined with proper Pydantic types,default_factoryfor mutable defaults, and backward-compatible defaults. TheLspTransportStrEnum is well-documented. Exports and__all__lists are correctly updated. The commit message matches the ticket's prescribed format exactly, the branch name is correct, and the milestone/label are properly assigned.However, the PR cannot be approved due to: (1) the
pipetransport value violating the specification, (2) two subtasks marked complete without corresponding code changes, (3) misleading${ENV_VAR}interpolation documentation, and (4) unresolved merge conflicts. These issues must be addressed before merging.3da587639bb2eefa47bcb2eefa47bc8061d4b030Response to Review — All Findings Addressed
Thanks for the thorough review. All 17 findings addressed:
Critical (1/1)
PIPEfromLspTransport. Enum now has onlySTDIOandTCPper spec line 20551. Updated docstring, Field description, tests, and Robot helper. Added scenario verifyingpipeis rejected.Major (5/5)
NodeLspBindingreferences servers by name only. The new fields live onLspServerConfigwhich is constructed from YAML viaLspServerConfig(**raw)-- Pydantic handles the new fields automatically. Noschema.pychanges needed.register()receives a validatedLspServerConfiginstance. This is consistent with the codebase pattern.${ENV_VAR}interpolation claims from both the docstring and Field description. Interpolation is not implemented and is out of scope.83c22b83). All conflicts resolved.Minor (7/7)
isinstance(exc, (ValueError, PydanticValidationError)).Description,Transport,Initialization Options, andWorkspace Settingstoagents lsp showRich panel output.Nits (5/5)
LspTransportto__init__.pyusage example.import jsonto module top-level.Given the LspTransport enum is definedto establish BDD context.initialization "python" value should equal {...}.assert original == deserialized(full model equality).Verification
83c22b83Review: feat(lsp): add missing LspServerConfig model fields
Approved. Clean model extension with excellent test coverage. No blocking issues.
What's Good
descriptionhasmax_length=1000,transportis enum-validated.__all__exports properly updated.8061d4b0303c19f52debNew commits pushed, approval review dismissed automatically according to repository settings
3c19f52deb99b7abe67999b7abe679c97ec273a9