fix: update model ID for sonar deep research in documentation and sup…#1192
fix: update model ID for sonar deep research in documentation and sup…#1192Crunchyman-ralph merged 3 commits intoeyaltoledano:nextfrom
Conversation
🦋 Changeset detectedLatest commit: 724c1af The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
WalkthroughRenames the Perplexity model ID from "deep-research" to "sonar-deep-research" in scripts/modules/supported-models.json. Adds a changeset entry documenting the patch release that fixes the failing model reference. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
scripts/modules/supported-models.json (1)
451-484: Optionally add a human-readable name field.To align with our guideline for model objects including
name, consider adding it (e.g., "Sonar Deep Research"). This is non-blocking and consistent with other providers that setname.{ - "id": "sonar-deep-research", + "id": "sonar-deep-research", + "name": "Sonar Deep Research", "swe_score": 0.211, "cost_per_1m_tokens": { "input": 2, "output": 8 }, "allowed_roles": ["research"], "max_tokens": 8700, "supported": true },docs/models.md (1)
1-209: Add a short migration note for the model rename (optional).A brief note in docs (separate page/section, not this generated file) stating “deep-research → sonar-deep-research” helps users update configs.
I can draft a minimal migration snippet if you want.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
docs/models.md(1 hunks)scripts/modules/supported-models.json(1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
scripts/modules/supported-models.json
📄 CodeRabbit inference engine (.cursor/rules/ai_providers.mdc)
Add a new key for the provider and an array of model objects under it in scripts/modules/supported-models.json, including id, name, allowed_roles, and optionally swe_score, cost_per_1m_tokens, and max_tokens.
Files:
scripts/modules/supported-models.json
scripts/modules/**
📄 CodeRabbit inference engine (.cursor/rules/dev_workflow.mdc)
When using the MCP server, restart it if core logic in
scripts/modulesor MCP tool/direct function definitions change.
Files:
scripts/modules/supported-models.json
scripts/modules/*
📄 CodeRabbit inference engine (.cursor/rules/tags.mdc)
scripts/modules/*: Every command that reads or writes tasks.json must be tag-aware
All command files must import getCurrentTag from utils.js
Every CLI command that operates on tasks must include the --tag CLI option
All commands must resolve the tag using the pattern: options.tag || getCurrentTag(projectRoot) || 'master'
All commands must find projectRoot with error handling before proceeding
All commands must pass { projectRoot, tag } as context to core functions
MCP direct functions must accept and use a context object containing projectRoot and tag, and pass them to core functions
Do not hard-code tag resolution (e.g., const tag = options.tag || 'master';); always use getCurrentTag
Do not omit the --tag CLI option in commands that operate on tasks
Do not omit the context parameter when calling core functions from commands
Do not call readJSON or writeJSON without passing projectRoot and tag
Files:
scripts/modules/supported-models.json
docs/**/*
📄 CodeRabbit inference engine (.cursor/rules/new_features.mdc)
Add feature documentation to '/docs' folder, include tagged system usage examples, update command reference documentation, and provide migration notes if relevant.
Files:
docs/models.md
🧠 Learnings (5)
📚 Learning: 2025-07-18T17:06:04.909Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/ai_providers.mdc:0-0
Timestamp: 2025-07-18T17:06:04.909Z
Learning: Applies to scripts/modules/supported-models.json : Add a new key for the provider and an array of model objects under it in scripts/modules/supported-models.json, including id, name, allowed_roles, and optionally swe_score, cost_per_1m_tokens, and max_tokens.
Applied to files:
scripts/modules/supported-models.json
📚 Learning: 2025-07-21T14:14:48.694Z
Learnt from: rtmcrc
PR: eyaltoledano/claude-task-master#933
File: scripts/modules/supported-models.json:238-238
Timestamp: 2025-07-21T14:14:48.694Z
Learning: Model version updates in scripts/modules/supported-models.json may be included in feature PRs if they provide practical improvements like reduced error rates, even if not directly related to the main feature being implemented.
Applied to files:
scripts/modules/supported-models.json
📚 Learning: 2025-08-08T11:34:45.482Z
Learnt from: Crunchyman-ralph
PR: eyaltoledano/claude-task-master#1105
File: .changeset/vast-weeks-fetch.md:5-5
Timestamp: 2025-08-08T11:34:45.482Z
Learning: In this repo, supported-models.md is auto-generated by CI from supported-models.json; do not request manual edits to that file—ensure JSON entries are correct instead.
Applied to files:
scripts/modules/supported-models.json
📚 Learning: 2025-08-08T11:34:45.482Z
Learnt from: Crunchyman-ralph
PR: eyaltoledano/claude-task-master#1105
File: .changeset/vast-weeks-fetch.md:5-5
Timestamp: 2025-08-08T11:34:45.482Z
Learning: In this repo, the supported models list is auto-generated by CI into docs/models.md from scripts/modules/supported-models.json via .github/workflows/update-models-md.yml and docs/scripts/models-json-to-markdown.js. Don’t request manual edits to the Markdown; ensure the JSON is correct instead.
Applied to files:
scripts/modules/supported-models.json
📚 Learning: 2025-08-08T11:34:45.482Z
Learnt from: Crunchyman-ralph
PR: eyaltoledano/claude-task-master#1105
File: .changeset/vast-weeks-fetch.md:5-5
Timestamp: 2025-08-08T11:34:45.482Z
Learning: This repo’s supported models list is CI-generated into docs/models.md from scripts/modules/supported-models.json (workflow: .github/workflows/update-models-md.yml using docs/scripts/models-json-to-markdown.js). Don’t request manual edits to the Markdown; ensure the JSON is correct instead. README links to docs/models.md.
Applied to files:
scripts/modules/supported-models.json
🔇 Additional comments (3)
scripts/modules/supported-models.json (2)
475-484: Rename looks correct; roles/pricing preserved.
idupdated to "sonar-deep-research";allowed_roles: ["research"], costs, and max_tokens unchanged—consistent with the PR goal.
1-1021: No lingering “deep-research” references
Only occurrences of the new ID “sonar-deep-research” remain inscripts/modules/supported-models.jsonanddocs/models.md; no plain “deep-research” usages were found.docs/models.md (1)
95-116: External naming confirmed. Perplexity’s official model ID for Deep Research issonar-deep-research, matching vendor documentation.
docs/models.md
Outdated
| | perplexity | sonar-pro | — | 3 | 15 | | ||
| | perplexity | sonar | — | 1 | 1 | | ||
| | perplexity | deep-research | 0.211 | 2 | 8 | | ||
| | perplexity | sonar-deep-research | 0.211 | 2 | 8 | |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Do not hand-edit docs/models.md; CI auto-generates this file.
This Markdown is produced from scripts/modules/supported-models.json by a workflow; manual edits will be overwritten. Please revert this change and rely on CI to regenerate after the JSON update.
🤖 Prompt for AI Agents
In docs/models.md around line 114, the file was manually edited (the
perplexity/sonar-deep-research row was changed) but this file is auto-generated
from scripts/modules/supported-models.json; revert the manual change in
docs/models.md and instead update the source JSON
(scripts/modules/supported-models.json) with the intended model entry or values,
then let CI regenerate docs/models.md so changes persist.
There was a problem hiding this comment.
@Crunchyman-ralph Thanks for confirming! The JSON update in scripts/modules/supported-models.json looks correct, and CI will handle regenerating the docs automatically. 👍
🧠 Learnings used
Learnt from: Crunchyman-ralph
PR: eyaltoledano/claude-task-master#1105
File: .changeset/vast-weeks-fetch.md:5-5
Timestamp: 2025-08-08T11:34:45.482Z
Learning: In this repo, the supported models list is auto-generated by CI into docs/models.md from scripts/modules/supported-models.json via .github/workflows/update-models-md.yml and docs/scripts/models-json-to-markdown.js. Don’t request manual edits to the Markdown; ensure the JSON is correct instead.
Learnt from: Crunchyman-ralph
PR: eyaltoledano/claude-task-master#1105
File: .changeset/vast-weeks-fetch.md:5-5
Timestamp: 2025-08-08T11:34:45.482Z
Learning: In this repo, supported-models.md is auto-generated by CI from supported-models.json; do not request manual edits to that file—ensure JSON entries are correct instead.
Learnt from: Crunchyman-ralph
PR: eyaltoledano/claude-task-master#1105
File: .changeset/vast-weeks-fetch.md:5-5
Timestamp: 2025-08-08T11:34:45.482Z
Learning: This repo’s supported models list is CI-generated into docs/models.md from scripts/modules/supported-models.json (workflow: .github/workflows/update-models-md.yml using docs/scripts/models-json-to-markdown.js). Don’t request manual edits to the Markdown; ensure the JSON is correct instead. README links to docs/models.md.
Learnt from: Crunchyman-ralph
PR: eyaltoledano/claude-task-master#1105
File: scripts/modules/supported-models.json:242-254
Timestamp: 2025-08-08T11:33:15.297Z
Learning: Preference: In scripts/modules/supported-models.json, the "name" field is optional. For OpenAI entries (e.g., "gpt-5"), Crunchyman-ralph prefers omitting "name" when the id is explicit enough; avoid nitpicks requesting a "name" in such cases.
Learnt from: Crunchyman-ralph
PR: eyaltoledano/claude-task-master#1178
File: packages/tm-core/src/auth/config.ts:5-7
Timestamp: 2025-09-02T21:51:27.921Z
Learning: The user Crunchyman-ralph prefers not to use node: scheme imports (e.g., 'node:os', 'node:path') for Node.js core modules and considers suggestions to change bare imports to node: scheme as too nitpicky.
docs/models.md
Outdated
| | perplexity | sonar-pro | — | 3 | 15 | | ||
| | perplexity | sonar | — | 1 | 1 | | ||
| | perplexity | deep-research | 0.211 | 2 | 8 | | ||
| | perplexity | sonar-deep-research | 0.211 | 2 | 8 | |
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
.changeset/silly-pandas-find.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
.changeset/*.md
📄 CodeRabbit inference engine (.cursor/rules/changeset.mdc)
.changeset/*.md: When runningnpm run changesetornpx changeset add, provide a concise summary of the changes for theCHANGELOG.mdin imperative mood, typically a single line, and not a detailed Git commit message.
The changeset summary should be user-facing, describing what changed in the released version that is relevant to users or consumers of the package.
Do not use your detailed Git commit message body as the changeset summary.
Files:
.changeset/silly-pandas-find.md
.changeset/*
📄 CodeRabbit inference engine (.cursor/rules/new_features.mdc)
Create appropriate changesets for new features, use semantic versioning, include tagged system information in release notes, and document breaking changes if any.
Files:
.changeset/silly-pandas-find.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: rtmcrc
PR: eyaltoledano/claude-task-master#933
File: scripts/modules/supported-models.json:238-238
Timestamp: 2025-07-21T14:14:48.694Z
Learning: Model version updates in scripts/modules/supported-models.json may be included in feature PRs if they provide practical improvements like reduced error rates, even if not directly related to the main feature being implemented.
🪛 markdownlint-cli2 (0.18.1)
.changeset/silly-pandas-find.md
5-5: First line in a file should be a top-level heading
(MD041, first-line-heading, first-line-h1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Test
🔇 Additional comments (2)
.changeset/silly-pandas-find.md (2)
1-3: Frontmatter format looks correct for Changesets.
YAML block and package bump type are valid.
2-2: Verified — changeset package "task-master-ai" exists at repo root.
Found package.json at repository root with name "task-master-ai" — no change required.
This PR was automatically generated to update documentation based on recent changes. Original commit: fix: update model ID for sonar deep research (#1192)\n\nCo-authored-by: Ralph Khreish <35776126+Crunchyman-ralph@users.noreply.github.com>\n\n Co-authored-by: Claude <claude-assistant@anthropic.com>
Co-authored-by: Ralph Khreish <35776126+Crunchyman-ralph@users.noreply.github.com>
…ported models
What type of PR is this?
Description
There is no deep-research model anymore renamed sonar-deep-research
Ref: https://docs.perplexity.ai/getting-started/models/models/sonar-deep-research
Related Issues
How to Test This
# Example commands or stepsExpected result:

Contributor Checklist
npm run changesetnpm testnpm run format-check(ornpm run formatto fix)Changelog Entry
For Maintainers
Summary by CodeRabbit
Bug Fixes
Chores