Skip to content

Enhance MCP Server documentation#6101

Merged
sahandilshan merged 1 commit into
wso2:masterfrom
sahandilshan:mcp
May 5, 2026
Merged

Enhance MCP Server documentation#6101
sahandilshan merged 1 commit into
wso2:masterfrom
sahandilshan:mcp

Conversation

@sahandilshan
Copy link
Copy Markdown
Contributor

@sahandilshan sahandilshan commented May 5, 2026

Purpose

Enhance MCP Server documentation with build instructions and update configuration details

Screenshot 2026-05-05 at 12 05 56 PM
Screenshot 2026-05-05 at 12 06 58 PM

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 5, 2026

📝 Walkthrough

Walkthrough

The 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.

Changes

Asgardeo MCP Documentation Updates

Layer / File(s) Summary
Quick-start Build Instructions
en/includes/quick-starts/mcp-server.md
New "Build the Asgardeo MCP Server" section with git clone, go mod tidy, go build -o asgardeo-mcp steps and instructions to use the binary's absolute path.
VS Code Configuration Setup
en/includes/quick-starts/mcp-server.md
VS Code instructions updated to use "MCP: Open User Configuration" targeting mcp.json with "servers" root structure instead of settings.json with "mcp" nesting.
Authorization Scope Reference
en/includes/references/mcp-tool-api-resource-access.md
Scope requirements for get_application_by_name and get_application_by_client_id simplified to internal_application_mgt_view only, removing prior create and claim/OIDC scope entries.

Suggested labels

Team/Identity Server Core

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description provides a clear purpose but lacks required sections from the template including Related PRs, Test environment, and Security checks. Add missing sections: Related PRs, Test environment details, and complete the Security checks checklist with appropriate selections and confirmations.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Enhance MCP Server documentation' clearly and concisely summarizes the main change: improving MCP Server documentation with build instructions and configuration updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (2)
en/includes/quick-starts/mcp-server.md (2)

72-72: 💤 Low value

Consider 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 value

Add article for clarity.

The phrase "to mcp.json file" 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

📥 Commits

Reviewing files that changed from the base of the PR and between 4549329 and 75f0115.

📒 Files selected for processing (2)
  • en/includes/quick-starts/mcp-server.md
  • en/includes/references/mcp-tool-api-resource-access.md

@sahandilshan sahandilshan merged commit fba7254 into wso2:master May 5, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants