Enhance MCP Server documentation#6101
Conversation
…onfiguration details
📝 WalkthroughWalkthroughThe PR updates Asgardeo MCP documentation with local build instructions for the server, updates VS Code configuration setup to use the official MCP configuration format, and revises authorization scope requirements for application-related MCP tools to use only the view scope. ChangesAsgardeo MCP Documentation Updates
Suggested labels
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
🧹 Nitpick comments (2)
en/includes/quick-starts/mcp-server.md (2)
72-72: 💤 Low valueConsider using more direct, active voice.
The phrase "is what you will use" contains a weak 'be' verb. Consider rephrasing for directness: "Use this absolute path as
<ABSOLUTE-PATH>in the next step."As per coding guidelines: Reduce unnecessary use of weak 'be' verbs (am, is, are, was, were) and prefer direct verbs.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/quick-starts/mcp-server.md` at line 72, Replace the passive/weak-verb sentence "This creates the `asgardeo-mcp` binary in the current directory. The absolute path to this binary (e.g., `/Users/<username>/asgardeo-mcp-server/asgardeo-mcp`) is what you will use as `<ABSOLUTE-PATH>` in the next step." with a direct, active formulation such as: "This creates the `asgardeo-mcp` binary in the current directory; use its absolute path (e.g., `/Users/<username>/asgardeo-mcp-server/asgardeo-mcp`) as `<ABSOLUTE-PATH>` in the next step." Ensure the `<ABSOLUTE-PATH>` token and example path remain unchanged.
81-81: 💤 Low valueAdd article for clarity.
The phrase "to
mcp.jsonfile" is missing the article "the" before the filename.📝 Proposed fix
- Add the following server configuration to `mcp.json` file. Replace the `<ABSOLUTE-PATH>`, `<client-id>`, `<client-secret>` and `<organization>` values from the values you copied from the previous steps. + Add the following server configuration to the `mcp.json` file. Replace the `<ABSOLUTE-PATH>`, `<client-id>`, `<client-secret>`, and `<organization>` values with the values you copied from the previous steps.Note: Also added Oxford comma before "and" and changed "from the values" to "with the values" for better grammar.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/includes/quick-starts/mcp-server.md` at line 81, Modify the sentence that currently reads "Add the following server configuration to `mcp.json` file..." so it includes the definite article and improved grammar; change it to "Add the following server configuration to the `mcp.json` file. Replace the `<ABSOLUTE-PATH>`, `<client-id>`, `<client-secret>`, and `<organization>` values with the values you copied from the previous steps."; update the phrase around `mcp.json` and add the Oxford comma and "with the values" as shown.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@en/includes/quick-starts/mcp-server.md`:
- Line 72: Replace the passive/weak-verb sentence "This creates the
`asgardeo-mcp` binary in the current directory. The absolute path to this binary
(e.g., `/Users/<username>/asgardeo-mcp-server/asgardeo-mcp`) is what you will
use as `<ABSOLUTE-PATH>` in the next step." with a direct, active formulation
such as: "This creates the `asgardeo-mcp` binary in the current directory; use
its absolute path (e.g., `/Users/<username>/asgardeo-mcp-server/asgardeo-mcp`)
as `<ABSOLUTE-PATH>` in the next step." Ensure the `<ABSOLUTE-PATH>` token and
example path remain unchanged.
- Line 81: Modify the sentence that currently reads "Add the following server
configuration to `mcp.json` file..." so it includes the definite article and
improved grammar; change it to "Add the following server configuration to the
`mcp.json` file. Replace the `<ABSOLUTE-PATH>`, `<client-id>`,
`<client-secret>`, and `<organization>` values with the values you copied from
the previous steps."; update the phrase around `mcp.json` and add the Oxford
comma and "with the values" as shown.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: db99d910-9bac-49c2-a651-9a991ee065da
📒 Files selected for processing (2)
en/includes/quick-starts/mcp-server.mden/includes/references/mcp-tool-api-resource-access.md
Purpose
Enhance MCP Server documentation with build instructions and update configuration details