feat(lsp): add missing LspServerConfig model fields #1064
Merged
hamza.khyari
merged 1 commits from 2026-03-30 12:07:29 +00:00
feature/lsp-config-fields into master
Dismiss Review
Are you sure you want to dismiss this review?
Labels
Clear labels
auto/needs-reevaluation
controller-managed
overdue
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
Needs Feedback
Signed-off: Owner
Signed-off: Scrum Master
Signed-off: Tech Lead
Spike
Controller deferred this PR; awaiting Phase 6+ scope-evaluator or operator re-enablement.
Auto-agents controller manages this PR/issue (see tools/controller/deploy/RUNBOOK.md). Remove this label to abandon controller management.
PR blocked by an open issue dependency. Operator must close the dep (or remove the dependency link) before the merge driver can act. Auto-cleared by merge_drive when no open deps remain.
Most recent merge cycle hit CI timeout. Driver excludes this PR while last merge_cycle row is < 30 min old; label persists thereafter as visible history.
Currently being processed by an implementer worker.
Currently being processed by the merge driver.
Currently being processed by a reviewer worker.
Merge driver heartbeat stale; pipeline halted. Closed automatically on next clean tick.
Detected master commit violating the strict merge invariant. Tracked as an issue (not a PR label); kept here for label completeness.
In-cycle escalation: most recent attempt ran at the Tier 0 slot (`tier-0`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 1 slot (`tier-1`). Slot's model defined in .opencode/models/tiers.yaml.
In-cycle escalation: most recent attempt ran at the Tier 2 slot (`tier-2`). Slot's model defined in .opencode/models/tiers.yaml. Gated behind IMPLEMENTER_ESCALATION_TIER2_ENABLED.
In-cycle escalation: most recent attempt ran at the Tier -1 slot (`tier-min`). Slot's model defined in .opencode/models/tiers.yaml. Suffix is ``-min`` (not ``--1``) so the Forgejo UI reads naturally.
Tracking issues used by the AI Automation system for agents to communicate and report.
Rebase conflict needs LLM conflict-resolver.
Failing CI needs implementer attention.
Documenting a driver incident or rollback.
Reviewer has APPROVED this PR and no later REQUEST_CHANGES is outstanding. The merge driver requires this label to even consider a PR for merging. Set by the reviewer worker on APPROVE; cleared on REQUEST_CHANGES.
Train repeatedly lost master-tempo races. Driver excludes via merge_cycle until cooldown elapses; label persists as visible history.
Revert PR backing out an invariant violation. Fast-tracked through the merge driver.
Sentinel PR duplicated from upstream into a personal fork by tools/duplicate_prs_to_fork.py for pipeline testing. Lives only in the fork; the canonical pipeline never sees it.
No implementer activity for N days. Flagged for human review. Auto-cleared on next push to head branch.
Repeatedly fails on current master (>= 3 ci-fail-on-rebased-sha releases in 12 h). Excluded from driver until human triage.
A ticket in a blocked state and unable to complete until some other task is completed first.
Bounty
$100
A bounty of $100 for any open-source contributor who provides a MR that solves this issue
Bounty
$1000
A bounty of $1000 for any open-source contributor who provides a MR that solves this issue
Bounty
$10000
A bounty of $10000 for any open-source contributor who provides a MR that solves this issue
Bounty
$20
A bounty of $20 for any open-source contributor who provides a MR that solves this issue
Bounty
$2000
A bounty of $2000 for any open-source contributor who provides a MR that solves this issue
Bounty
$250
A bounty of $250 for any open-source contributor who provides a MR that solves this issue
Bounty
$50
A bounty of $50 for any open-source contributor who provides a MR that solves this issue
Bounty
$500
A bounty of $500 for any open-source contributor who provides a MR that solves this issue
Bounty
$5000
A bounty of $5000 for any open-source contributor who provides a MR that solves this issue
Bounty
$750
A bounty of $750 for any open-source contributor who provides a MR that solves this issue
MoSCoW
Could have
Could have feature in order to satisfy the epic/legendary.
MoSCoW
Must have
Must have feature in order to satisfy the epic/legendary.
MoSCoW
Should have
Should have feature in order to satisfy the epic/legendary.
There are questions in the ticket that can not be completed until the project owner provides clarity.
Points
1
1 man-hours worth of work for an expert with no learning curve.
Points
13
13 man-hours worth of work for an expert with no learning curve.
Points
2
2 man-hours worth of work for an expert with no learning curve.
Points
21
21 man-hours worth of work for an expert with no learning curve.
Points
3
3 man-hours worth of work for an expert with no learning curve.
Points
34
34 man-hours worth of work for an expert with no learning curve.
Points
5
5 man-hours worth of work for an expert with no learning curve.
Points
55
55 man-hours worth of work for an expert with no learning curve.
Points
8
8 man-hours worth of work for an expert with no learning curve.
Points
88
88 man-hours worth of work for an expert with no learning curve.
Priority
Backlog
This ticket has backlogged priority and is not to be worked on yet
Priority
CI Blocker
Critical priority issue that blocks CI/CD pipeline and prevents PR merges
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
When an epic or legendary is in review it must be signed off by owner, tech lead, and scrum master before being marked as completed.
A ticket for learning a tool or technology that is needed to be able to do future planning and design.
State
Completed
The ticket has been fully implemented, completed, and merged with the source code. This label should only be applied once a ticket is closed.
State
Duplicate
A ticket that represents the same content as an existing ticket.
State
In Progress
A ticket that is actively being developed.
State
In Review
A ticket that has had some code completed to implement but is waiting to pass peer review and is not yet merged in.
State
Paused
This ticket's work started but wasn't finished. It's on hold (likely in a feature branch) and will be resumed later, either due to a blocker or a delay.
State
Unverified
All new tickets start in this state. A developer may set it to show the ticket is unverified. This means we haven't agreed to work on it. It will either move to a verified state or be closed as wontdo.
State
Verified
The issue has been verified by a developer as legitimate. It will be worked on and verified tickets are now considered part of the backlog.
State
Wont Do
This ticket has been decided it wont be done. This may mean the bug has been determined to not be real (cant verify) or the feature is one we have decided we dont want to adopt.
Type
Automation
Any edits or discussion about the AI automated coding system.
Type
Bug
Something that doesnt work as intended.
Type
Discussion
Anytime a ticket represents a discussion about a subject and doesnt fall into one of the other categories.
Type
Documentation
An error or improvement needed in the documentation.
Type
Epic
Any first tier epic. That is, an epic which contains only issues as children and will not have sub-epics.
Type
Feature
Some new functionality not present.
Type
Legendary
A type of Epic which will contain other Epics.
Type
Refactor
A code change that restructures existing code without changing its external behavior.
Type
Support
Someone needs help using the project.
Type
Task
A generic task that doesnt fit into the other type categories.
Type
Testing
Work exclusively focusing on fixing or expanding testing.
Projects
Clear projects
No project
Assignees
aditya (Aditya Chhabra)
aleenaumair (Aleena Umair)
brent.edwards (Brent Edwards)
CoreRasurae (Luis Mendes)
drew (Drew Morris)
eugen.thaci (Eugen Thaci)
freemo (Jeffrey Phillips Freeman)
HAL9000 (HAL 9000)
HAL9001 (HAL9001)
hamza.khyari (Hamza Khyari)
hurui200320 (Rui Hu)
justin.morris
khird (Kyle Hird)
org.cleveragents
Clear assignees
No Assignees
hamza.khyari
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: cleveragents/cleveragents-core#1064
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
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.3da587639btob2eefa47bcb2eefa47bcto8061d4b030Response 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.8061d4b030to3c19f52debNew commits pushed, approval review dismissed automatically according to repository settings
3c19f52debto99b7abe67999b7abe679toc97ec273a9