Skip to content

[DEV-1750] Add MCP and agent skills getting-started docs - #966

Merged
w1am merged 2 commits into
masterfrom
docs-mcp-agent-skills
Jun 2, 2026
Merged

[DEV-1750] Add MCP and agent skills getting-started docs#966
w1am merged 2 commits into
masterfrom
docs-mcp-agent-skills

Conversation

@w1am

@w1am w1am commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Adds getting-started docs for MCP and agent skills, with sidebar and README links.

@w1am
w1am requested a review from a team as a code owner June 1, 2026 07:34
@github-actions

github-actions Bot commented Jun 1, 2026 •
edited
Loading

Copy link
Copy Markdown

Docs build

@qodo-code-review

qodo-code-review Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Review Summary by Qodo

Add Agent Skills and MCP Servers getting-started documentation

📝 Documentation

Grey Divider

Walkthroughs

Description 
• Adds two new getting-started guides for AI agent integration
• Introduces Agent Skills documentation covering five skills and three agents
• Introduces MCP Servers documentation for KurrentDB integration
• Updates sidebar navigation and homepage with new documentation links
Diagram 
flowchart LR
  A["Documentation Structure"] --> B["Sidebar Config"]
  A --> C["Homepage README"]
  B --> D["Agent Skills Link"]
  B --> E["MCP Servers Link"]
  C --> F["Code with AI Section"]
  F --> D
  F --> E
  D --> G["agent-skills.md"]
  E --> H["mcp.md"]
Loading

Grey Divider

File Changes

1. docs/.vuepress/configs/sidebar.ts 📝 Documentation +10/-0

Add Agent Skills and MCP navigation links

• Adds two new sidebar navigation entries under "Getting Started" group
• Links to new agent-skills.md and mcp.md documentation pages
• Maintains consistent sidebar structure and formatting

docs/.vuepress/configs/sidebar.ts

2. docs/README.md 📝 Documentation +12/-0

Add AI integration section to homepage

• Adds new "Code with AI" section to homepage highlights
• Includes two feature cards for Agent Skills and MCP
• Provides links to both new getting-started guides
• Uses icon for MCP server feature

docs/README.md

3. docs/getting-started/agent-skills.md 📝 Documentation +145/-0

New Agent Skills getting-started documentation

• Comprehensive guide to Kurrent Agent Skills for AI coding assistants
• Documents five available skills with links to repositories
• Describes three specialized agents for migration, review, and troubleshooting
• Provides installation instructions for Claude Code, Cursor, Codex, GitHub Copilot CLI, and Vercel
 skills CLI
• Includes local installation and contribution guidelines

docs/getting-started/agent-skills.md

View more (1)
4. docs/getting-started/mcp.md 📝 Documentation +130/-0

New MCP Servers getting-started documentation

• Introduces Model Context Protocol servers for KurrentDB integration
• Documents two available MCP servers with use cases and capabilities
• Provides detailed configuration examples for VS Code, Claude Desktop, Cursor, and Windsurf
• Includes prerequisites and connection setup instructions
• References Gaffer MCP server documentation for projection development

docs/getting-started/mcp.md

Grey Divider

Qodo Logo

@qodo-code-review

qodo-code-review Bot commented Jun 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (1)

Grey Divider


Remediation recommended

1. KurrentDB casing inconsistent 📘 Rule violation ⚙ Maintainability
Description 
The MCP configuration examples use inconsistent casing for the same server identifier (KurrentDB
vs kurrentdb) and refer to kurrentdb in placeholder text, which can confuse readers and reduces
terminology consistency across the page.
Code

docs/getting-started/mcp.md[R47-107]

Evidence 
PR Compliance ID 3 requires consistent, normalized capitalization/terminology across prose and
examples. In mcp.md, the examples alternate between "KurrentDB" and "kurrentdb" for the same
MCP server identifier and also use lowercase kurrentdb in placeholder text, demonstrating
inconsistent casing.

docs/getting-started/mcp.md[47-107]
Best Practice: Repository guidelines

Agent prompt 
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The MCP docs use inconsistent capitalization/terminology for the same server name and placeholders (e.g., `KurrentDB` vs `kurrentdb`, and `insert kurrentdb connection here`). This violates the requirement to normalize capitalization/terminology across documentation and examples.

## Issue Context
Readers may copy/paste config snippets; inconsistent casing makes it unclear what naming is recommended and looks unpolished.

## Fix Focus Areas
- docs/getting-started/mcp.md[47-107]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Advisory comments

2. Unvalidated internal .html links 🐞 Bug ⚙ Maintainability
Description 
docs/README.md adds internal links ending in .html, but linkCheckPlugin explicitly skips
validating any link that ends with .html, so these new links won’t be caught by CI if they become
stale. This reduces the effectiveness of the repo’s broken-link detection for the new homepage
entries.
Code

docs/README.md[R114-121]

Evidence 
The link checker explicitly skips .html links, and the PR introduces new internal .html links in
the homepage frontmatter, so these new links won’t be validated by the checker.

docs/.vuepress/markdown/linkCheck/index.ts[39-44]
docs/README.md[111-122]

Agent prompt 
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The markdown link checker (`linkCheckPlugin`) skips all links that end with `.html`, so the new internal homepage links added in `docs/README.md` are not validated during the docs build.

### Issue Context
- `linkCheckPlugin` currently returns early for any `href` ending in `.html`.
- The PR adds two new internal links using `.html` paths under `/getting-started/`.

### Fix Focus Areas
Choose one of these approaches:
1) **Enhance the checker**: Update `linkCheckPlugin` to also validate internal absolute `.html` links by mapping them to their corresponding source `.md` (and handling directory `/foo/` -> `/foo/README.md` cases).
2) **Change link style**: If `.md` route paths are acceptable in this site, change the two new links in `docs/README.md` to `.md` so the existing checker validates them.

- docs/.vuepress/markdown/linkCheck/index.ts[39-44]
- docs/README.md[111-122]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Grey Divider

Qodo Logo

@w1am w1am changed the title Add MCP and agent skills getting-started docs [DEV-1750] Add MCP and agent skills getting-started docs Jun 1, 2026
@linear-code

linear-code Bot commented Jun 1, 2026

Copy link
Copy Markdown

DEV-1750

@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown

Docs build

@w1am
w1am force-pushed the docs-mcp-agent-skills branch from bf67090 to dc69a17 Compare June 1, 2026 07:40
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 1, 2026 •
edited
Loading

Copy link
Copy Markdown

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: dc69a17
Status: ✅  Deploy successful!
Preview URL: https://d0741dad.documentation-21k.pages.dev
Branch Preview URL: https://docs-mcp-agent-skills.documentation-21k.pages.dev

View logs

@w1am
w1am merged commit 9d7f603 into master Jun 2, 2026
3 checks passed
@w1am
w1am deleted the docs-mcp-agent-skills branch June 2, 2026 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@stktung stktung stktung approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@w1am @stktung