property description is not allowed in custom_modes.yaml

[M-Kepler]

App Version

3.23.15

API Provider

Not Applicable / Other

Model Used

N/A

Roo Code Task Links (Optional)

N/A

🔁 Steps to Reproduce

click here to open custom modes config

Property description is not allowed.yaml-schema: Custom Mode(513)

💥 Outcome Summary

Expected no errors, but it does

📄 Relevant Logs or Errors (Optional)

[roomote]

I am investigating this issue. The problem appears to be that the "description" property is not allowed in the custom_modes.json schema validation. I will identify the schema definition and update it to allow the description field.

[dosubot]

The Roo Code docs say the description property is supported in custom_modes.json and is meant to show a short summary in the mode selector UI (source). If you’re seeing “property description is not allowed,” it’s likely the app’s schema validation is stricter or out of sync with the docs for version 3.23.15.

If you need things working right away, removing the description property from your JSON config should resolve the error. If you want to keep a description for reference, you could add it as a comment (if your editor supports JSONC) or move it to another supported property like roleDefinition for now.

This mismatch between the docs and the app looks like a known issue—worth keeping an eye on release notes for updates or fixes.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}   

[roomote]

I'm investigating this issue. The problem appears to be that VS Code is applying an external YAML schema validation that doesn't recognize the 'description' field in custom modes configuration.

The project's internal schema already supports the description field (defined in packages/types/src/mode.ts), and I can see it's being used in the .roomodes file. I'll work on providing a proper JSON schema that VS Code can use for validation to resolve this error.

[roomote]

I've created a pull request to fix this issue: #5939

The solution adds a JSON schema for custom modes YAML validation that includes the 'description' field. This will resolve the VS Code validation error you're experiencing.

The PR has passed all CI checks and is ready for review.

[daniel-lxs]

I've looked into this and can confirm that our YAML schema is correct - the 'description' field is properly defined as an optional field in our schema definitions.

It seems like VS Code might be applying an external YAML validation that doesn't recognize this field. This could be coming from a YAML extension or some other VS Code setting.

Could you share your complete custom_modes.yaml file? This would help us see if there's something specific in your file structure that might be triggering this validation error.