Skip to content

docs: update MCP server documentation for v0.3.1 - #503

Open
akhil-vamshi-konam wants to merge 1 commit into
masterfrom
chore-update-mcp-docs
Open

docs: update MCP server documentation for v0.3.1#503
akhil-vamshi-konam wants to merge 1 commit into
masterfrom
chore-update-mcp-docs

Conversation

@akhil-vamshi-konam

@akhil-vamshi-konam akhil-vamshi-konam commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Description

Updated the MCP server documentation to reflect the latest changes in v0.3.1, including new tools, actions, resources, and updated behavior.

  • Updated MCP server from 28 tools / 183 actions to 30 tools / 204 actions.
  • Added documentation for Collections and Templates.
  • Updated workspace and project scope behavior for states, work item types, properties, and templates.
  • Clarified the required workspace-wide Read and Write OAuth scopes and invalid_scope troubleshooting.
  • Updated Pages, Projects, Cycles, and related action references.
  • Updated structured logging documentation to include the resource and action fields.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Test Scenarios

  • Reviewed the updated documentation against the MCP server's current tools and actions.
  • Verified the documented tool/action counts and newly added resource sections.
  • Verified OAuth scope and troubleshooting documentation against the current behavior.

Summary by CodeRabbit

  • Documentation
    • Updated MCP server documentation to version 0.3.1, covering 30 tools and 204 actions.
    • Added guidance for workspace-wide OAuth permissions and troubleshooting invalid_scope errors.
    • Documented new page, collection, and template capabilities, including page organization and management.
    • Clarified project, state, estimate, and cycle behaviors, including ownership, scope, and transfer requirements.
    • Expanded workspace capabilities and structured server log details.

@vercel

vercel Bot commented Aug 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview Aug 21, 2026 5:11am
docs Ready Ready Preview Aug 21, 2026 5:11am

Request Review

@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 756add70-1fdd-4bec-a1a3-a8cd7c62b490

📥 Commits

Reviewing files that changed from the base of the PR and between 6ea3aa0 and da30826.

📒 Files selected for processing (3)
  • apps/developer-docs/docs/dev-tools/mcp-server-self-host.md
  • apps/developer-docs/docs/dev-tools/mcp-server-tools.md
  • apps/developer-docs/docs/dev-tools/mcp-server.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The MCP server documentation now covers workspace-wide OAuth scopes, 30 tools, 204 actions, expanded page, collection, template, and workflow-state operations, updated project and cycle behavior, and structured resource/action logging.

Changes

MCP server documentation

Layer / File(s) Summary
OAuth scope guidance
apps/developer-docs/docs/dev-tools/mcp-server-self-host.md
Setup and troubleshooting now require workspace-wide Read and Write permissions and document the invalid_scope error.
Tool scopes and action behavior
apps/developer-docs/docs/dev-tools/mcp-server-tools.md
The reference updates scope resolution, estimate creation, cycle transfers, project descriptions, and workflow-state behavior.
Pages, collections, and templates
apps/developer-docs/docs/dev-tools/mcp-server-tools.md
The reference adds nested and collection-filed page operations, collection actions, and work item, page, and project templates.
Server metadata and capabilities
apps/developer-docs/docs/dev-tools/mcp-server-tools.md, apps/developer-docs/docs/dev-tools/mcp-server.md
The documentation updates version and action counts, expands capabilities, and adds resource and action names to structured logs.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: 🔵 Low · up to da308

The PR updates OAuth scope guidance, but the workspace-wide read/write mapping and invalid_scope troubleshooting should be confirmed before merge to avoid misleading setup instructions. The change is otherwise mergeable with explicit owner follow-up.

Suggested reviewers: vihar

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: updating MCP server documentation for version 0.3.1.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore-update-mcp-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant