-
Notifications
You must be signed in to change notification settings - Fork 3
v0.4.0 #58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
v0.4.0 #58
Conversation
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the WalkthroughVersion 0.4.0 release introducing mcp-from-openapi generator for the OpenAPI adapter, expanding Tool output schemas to support literal primitives and arrays, bumping package versions across all libraries, removing a PR trigger from CI workflows, and extensively updating documentation and contributor guidelines. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
Comment |
Co-authored-by: frontegg-david <69419539+frontegg-david@users.noreply.github.com>
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 5
🧹 Nitpick comments (2)
CONTRIBUTING.md (1)
38-42: Address LanguageTool style suggestion on repeated sentence structures.Line 42 contains three bullet points that begin with backtick-wrapped code references (
`). Consider rewording one or two to improve readability:- `README.md` for a high-level overview and quickstart. - `CHANGELOG.md` for release notes—update it when user-facing behavior changes. - `docs/` for the Mintlify-based documentation site (`yarn docs:local` runs a local preview). + For a high-level overview and quickstart, see `README.md`. + Consult `CHANGELOG.md` for release notes—update it when user-facing behavior changes. + The `docs/` folder hosts Mintlify-based documentation; run `yarn docs:local` to preview locally.docs/docs/servers/tools.mdx (1)
85-95: Minor grammar issue—add subject for clarity. Line 87 starts with a dependent clause. Consider: "TheinputSchemaparameter can be either a fullz.object({...})or a raw shape ({ name: z.string() }). The SDK wraps raw shapes in an object internally, so you can keep declarations terse."
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (25)
.github/workflows/codex-mintlify-docs.yml(1 hunks)CHANGELOG.md(1 hunks)CONTRIBUTING.md(1 hunks)README.md(9 hunks)docs/blog/11-2025/mcp-run-out-of-socket.mdx(1 hunks)docs/blog/external-links.mdx(1 hunks)docs/docs/adapters/openapi-adapter.mdx(2 hunks)docs/docs/guides/add-openapi-adapter.mdx(1 hunks)docs/docs/servers/tools.mdx(2 hunks)docs/draft/docs/adapters/openapi-adapter.mdx(24 hunks)docs/draft/docs/adapters/overview.mdx(8 hunks)docs/draft/docs/getting-started/quickstart.mdx(16 hunks)docs/draft/docs/guides/add-openapi-adapter.mdx(14 hunks)docs/draft/docs/guides/caching-and-cache-miss.mdx(26 hunks)docs/draft/docs/guides/customize-flow-stages.mdx(15 hunks)docs/draft/docs/plugins/cache-plugin.mdx(16 hunks)docs/updates.mdx(1 hunks)libs/adapters/README.md(1 hunks)libs/adapters/package.json(2 hunks)libs/cli/package.json(2 hunks)libs/json-schema-to-zod-v3/package.json(1 hunks)libs/mcp-from-openapi/package.json(1 hunks)libs/plugins/package.json(2 hunks)libs/sdk/package.json(2 hunks)package.json(1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
libs/**
⚙️ CodeRabbit configuration file
libs/**: Contains publishable SDK libraries. Review for API correctness, breaking changes, and consistency with docs. When public APIs change, ensure there is a matching docs/draft/docs/** update (not direct edits under docs/docs/**).
Files:
libs/mcp-from-openapi/package.jsonlibs/sdk/package.jsonlibs/cli/package.jsonlibs/plugins/package.jsonlibs/adapters/package.jsonlibs/json-schema-to-zod-v3/package.jsonlibs/adapters/README.md
docs/draft/docs/**
⚙️ CodeRabbit configuration file
docs/draft/docs/**: This folder holds the draft/source docs that humans are expected to edit. When authors want to add or change documentation, they should do it here. The Codex workflow uses these drafts, together with the code diff, to generate the latest docs under docs/docs/. As a reviewer: - Encourage contributors to add/update content here instead of docs/docs/. - It is fine to do structural/content feedback here (clarity, examples, etc).
Files:
docs/draft/docs/plugins/cache-plugin.mdxdocs/draft/docs/guides/add-openapi-adapter.mdxdocs/draft/docs/adapters/overview.mdxdocs/draft/docs/getting-started/quickstart.mdxdocs/draft/docs/guides/caching-and-cache-miss.mdxdocs/draft/docs/guides/customize-flow-stages.mdxdocs/draft/docs/adapters/openapi-adapter.mdx
docs/**
⚙️ CodeRabbit configuration file
docs/**: Repository documentation for the SDK, using MDX and hosted by Mintlify. See more specific rules for: - docs/docs/** (latest rendered docs, automation-only) - docs/v/** (archived versions, read-only) - docs/draft/docs/** (human-editable drafts) - docs/blogs/** (blogs, human edited) - docs/docs.json (Mintlify navigation)
Files:
docs/draft/docs/plugins/cache-plugin.mdxdocs/draft/docs/guides/add-openapi-adapter.mdxdocs/blog/11-2025/mcp-run-out-of-socket.mdxdocs/draft/docs/adapters/overview.mdxdocs/docs/guides/add-openapi-adapter.mdxdocs/draft/docs/getting-started/quickstart.mdxdocs/blog/external-links.mdxdocs/draft/docs/guides/caching-and-cache-miss.mdxdocs/docs/adapters/openapi-adapter.mdxdocs/draft/docs/guides/customize-flow-stages.mdxdocs/updates.mdxdocs/docs/servers/tools.mdxdocs/draft/docs/adapters/openapi-adapter.mdx
docs/docs/**
⚙️ CodeRabbit configuration file
docs/docs/**: This folder contains the latest Mintlify documentation for the CURRENT minor version, using SEO-friendly paths (e.g. "docs/getting-started/welcome"). These files are generated/updated by the Codex GitHub Action, NOT manually. When reviewing a PR: - If a contributor edits files under docs/docs/** directly, ask them to revert
those changes and instead update the corresponding draft under docs/draft/docs/**.
- Do NOT suggest manual edits here; suggest editing drafts and letting automation
regenerate docs/docs/**.- The release process for a new minor is:
- Copy the current docs/docs/** into docs/v/{previous-minor}/** to freeze them.
- Update docs/docs/** based on docs/draft/docs/** and the code changes.
Files:
docs/docs/guides/add-openapi-adapter.mdxdocs/docs/adapters/openapi-adapter.mdxdocs/docs/servers/tools.mdx
🧠 Learnings (1)
📚 Learning: 2025-11-16T22:47:05.139Z
Learnt from: frontegg-david
Repo: agentfront/frontmcp PR: 50
File: docs/docs/v/0.1/getting-started/welcome.mdx:2-3
Timestamp: 2025-11-16T22:47:05.139Z
Learning: In the agentfront/frontmcp repository, the docs/docs/v/** directory governance rule prohibiting manual edits applies to already-frozen releases, but does not preclude initial setup and bootstrap commits that establish the versioned docs structure.
Applied to files:
CONTRIBUTING.mdREADME.mddocs/updates.mdx
🪛 LanguageTool
CONTRIBUTING.md
[style] ~42-~42: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...user-facing behavior changes. - docs/ for the Mintlify-based documentation site (...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~106-~106: The wording of this phrase can be improved.
Context: ...eciate every contribution—thank you for making FrontMCP better!
(MAKE_STYLE_BETTER)
docs/draft/docs/adapters/overview.mdx
[uncategorized] ~233-~233: The official name of this software platform is spelled with a capital “H”.
Context: ...and adapter interfaces {' '} <Card title="Source Code" icon="github" href="https://github.com/agentfront/fr...
(GITHUB)
docs/docs/servers/tools.mdx
[style] ~87-~87: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...t & output schema shapes inputSchema can be a full z.object({...}) or a raw sh...
(MISSING_IT_THERE)
🪛 markdownlint-cli2 (0.18.1)
libs/adapters/README.md
17-17: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (30)
docs/draft/docs/guides/customize-flow-stages.mdx (4)
17-20: MDX formatting changes look good.The
{' '}spacing wraps between Card components are a standard MDX pattern for managing whitespace in JSX rendering. These changes improve visual consistency without affecting content.Also applies to: 22-25, 637-640
248-248: Code example formatting improves readability.Reformatting the
withRetrymethod signature to a single line maintains clarity while reducing visual bulk in the code sample. The example remains functionally correct.
542-542: Arrow function parentheses improve consistency.Adding parentheses around the parameter
his a minor style improvement that aligns with common TypeScript conventions. The logic remains identical.
549-551: Warning clarification is helpful.The updated text clearly signals this as an advanced feature, improving guidance for users on whether they should use the Hook Registry API. The messaging is appropriate.
libs/mcp-from-openapi/package.json (1)
3-3: Version bump is well-aligned with release objectives.Minor version bump (1.0.0 → 1.1.0) aligns with the v0.4.0 release and coordinated dependency updates across adapters and SDK. No API or export changes; backward compatible.
docs/blog/11-2025/mcp-run-out-of-socket.mdx (1)
7-12: Formatting improvement; no changes to content or behavior.Reformatting the self-closing img tag to multi-line JSX improves readability without altering semantics or functionality.
libs/json-schema-to-zod-v3/package.json (1)
3-3: Version bump aligns with coordinated ecosystem upgrade.Minor version bump (1.0.0 → 1.1.0) is consistent with the coordinated upgrade path across adapters and SDK libraries for the v0.4.0 release.
docs/blog/external-links.mdx (1)
24-30: Formatting improvement for consistency and readability.Multi-line Card component structure improves maintainability while preserving all prop values and behavior.
.github/workflows/codex-mintlify-docs.yml (1)
51-53: Quoting normalization improves consistency.Standardizing node setup options from single to double quotes aligns with YAML conventions and improves consistency across the workflow file.
docs/draft/docs/guides/caching-and-cache-miss.mdx (1)
1-50: Documentation improvements are in the correct location.Changes to
docs/draft/docs/**are appropriately placed for human-editable draft content per coding guidelines. Formatting improvements (bullet lists, inline MDX components, step-by-step restructuring) enhance clarity and readability without altering guide substance.docs/draft/docs/plugins/cache-plugin.mdx (1)
1-50: Documentation improvements are properly placed in draft docs.Changes to
docs/draft/docs/**are appropriate for human-editable source docs per coding guidelines. Formatting refinements (inline components with spacing, Warning/Check callouts, table restructuring) maintain MDX validity and improve readability and user guidance.CONTRIBUTING.md (1)
1-106: Comprehensive contributor guide aligns well with Nx monorepo structure and project standards.The guide covers prerequisites, workspace layout, day-to-day commands, coding standards, testing, documentation, PR workflows, and communication clearly. Tone is professional and actionable. Links are in place, and examples are practical.
Minor notes:
- Lines 56–57: Mention Inspector flow verification is good DX guidance; consider also noting
npx frontmcp doctoras a first troubleshooting step.- Line 65: Husky + lint-staged reference is accurate; the setup aligns with modern TypeScript projects.
- Line 103: Email address for security issues is hardcoded; ensure it's monitored or rotate if team changes.
docs/draft/docs/adapters/overview.mdx (1)
18-21: Formatting changes (MDX whitespace/inline wrapping) are minor and presentational.The inline {' '} wrapping and line-wrapping adjustments don't alter semantics or rendering. However, the pattern is inconsistently applied:
- Lines 18–21, 49, 74–77: Added {' '} before Card/Step blocks
- Lines 150–166, 216–217: Added {' '} before Card/Accordion blocks
- Some similar blocks unchanged (e.g., lines 28–30, 228–231)
If these changes are part of an automated formatter or style standardization pass, consider applying them uniformly across the file for consistency.
Also applies to: 49-49, 53-53, 74-77, 150-166, 216-217, 233-241
docs/draft/docs/getting-started/quickstart.mdx (1)
44-50: Formatting changes are purely presentational and consistent with other doc updates in this PR.These adjustments (line wrapping, {' '} wrapping, block collapsing) do not affect rendering or content. They align with similar edits in docs/draft/docs/adapters/overview.mdx. Assuming these changes support a docs formatter or automated linting pass, they are acceptable.
Also applies to: 78-78, 158-174, 247-261, 272-290, 301-308
CHANGELOG.md (1)
1-20: v0.4.0 changelog entry is clear and well-formatted, accurately summarizing major updates.The entry captures the three major themes:
- feat: OpenAPI adapter migration to mcp-from-openapi + enhanced output schemas
- docs: Updated authentication and mapper guidance
- build: Workflow improvements (publish-on-next-close, lint-staged, push workflow)
This aligns with the PR objectives and related file updates (docs/draft/docs/adapters/openapi-adapter.mdx, package version bumps, etc.).
docs/draft/docs/adapters/openapi-adapter.mdx (2)
513-517: Security risk levels table is clear and well-categorized.The table correctly maps configuration patterns to security risk levels (LOW / MEDIUM / HIGH), with accurate descriptions. The guidance to use
authProviderMapperorsecurityResolverfor LOW risk and warnings againstincludeSecurityInInputfor HIGH risk are sound.
129-131: Code examples show proper authentication patterns and are well-formatted.Examples demonstrate:
- Static headers (with security reminder)
- Auth provider mapper (recommended approach)
- Custom security resolver
- Dynamic headers/body mapping (multi-tenant use case)
- Real-world scenarios (GitHub, Slack, SaaS, expense management)
All examples appear syntactically correct and align with the mcp-from-openapi backend. Quote style in line 129 (
authorizationinstead of'authorization') is consistent with JavaScript object literal shorthand.Also applies to: 149-157, 289-302, 357-362, 399-410
README.md (2)
188-222: Function and Class Tools section clearly contrasts approaches and emphasizes Zod field shapes.The section now explicitly states: "Pass Zod fields directly (no
z.object({...}))" and provides side-by-side examples. This aligns with the coding guidelines referenced in the PR (Zod field shapes). Examples are accurate and readable.
436-448: Documentation reference links updated consistently.All cross-references (anchor links [1]–[13]) are updated to reflect docs.agentfront.dev paths and new doc structure. Links are clear and should remain stable if documentation routing is consistent.
package.json (2)
3-3: Version bump to 0.4.0 is correct and aligns with CHANGELOG entry.
15-25: Dependency removal verified as appropriate.Verification confirms the
json-schema-to-zod-v3removal from root dependencies is correct:
- Package is properly located in
libs/sdk/package.json- No root-level code imports this package
- Root build/dev scripts (
yarn dev,yarn build,yarn docs:local) use nx, which automatically resolves workspace dependencies- No breaking references detected
libs/plugins/package.json (1)
3-3: LGTM. Version alignment with adapters package is consistent at 1.1.0, and SDK dependency updated with caret constraint.Also applies to: 35-36
docs/draft/docs/guides/add-openapi-adapter.mdx (2)
8-22: Well-structured comprehensive guide update. The expanded guide provides step-by-step instructions, authentication strategies, and advanced configuration. Aligns well with the new mcp-from-openapi migration.
450-456: Documentation cross-references verified.Both paths referenced in the guide exist and are valid:
/docs/servers/authentication/overview→docs/docs/servers/authentication/overview.mdx✓/docs/servers/extensibility/plugins→docs/docs/servers/extensibility/plugins.mdx✓libs/cli/package.json (1)
3-3: LGTM. CLI package version bumped to 1.1.0 with matching dependencies on SDK, plugins, and adapters using appropriate caret constraints.Also applies to: 33-35
docs/updates.mdx (1)
8-31: Release notes accurately capture v0.4.0 changes. The Features, Docs, and Build/CI sections provide a good high-level summary of the mcp-from-openapi migration, enhanced tool schemas, and process improvements. Consider clarifying that the OpenAPI adapter is being upgraded (not newly created) if that's the case.docs/docs/servers/tools.mdx (1)
63-63: Excellent documentation of new Tool output schema capabilities. The updated metadata section clearly explains literal primitives, resource descriptors, Zod schemas, and tuple-style arrays. The example with['string', 'number']effectively demonstrates the new feature. Aligns well with the PR's goal of expanding output schema support.Also applies to: 65-65, 89-94, 101-101
docs/docs/adapters/openapi-adapter.mdx (1)
9-9: Well-documented mcp-from-openapi integration. The adapter documentation thoroughly covers the new features: automatic parameter conflict resolution, mapper visibility, multi-auth support, and risk scoring. The three authentication strategy examples (static headers, authProviderMapper, securityResolver) are clear and practical.Also applies to: 13-17
docs/docs/guides/add-openapi-adapter.mdx (1)
1-131: File is correctly auto-generated—no issues found. The git history confirms this file was updated via the Codex GitHub Action (commitcf038c6marked[auto]), not manually edited. The corresponding draft file exists atdocs/draft/docs/guides/add-openapi-adapter.mdx. The automation workflow is functioning as intended.libs/adapters/package.json (1)
3-3: The versioning strategy is intentional and correct—no changes needed.The monorepo is properly configured with:
- Workspace root (@frontmcp/source) at version 0.4.0
- All publishable libraries (6 total) uniformly versioned at 1.1.0
- Internal dependencies precisely pinned (1.1.0), SDK dependency flexibly versioned (^1.1.0)
This is standard monorepo practice: workspace roots and publishable packages maintain separate version tracks. The unified 1.1.0 across all libs demonstrates this is an intentional, coordinated release of the library suite—not a misalignment.
Likely an incorrect or invalid review comment.
Co-authored-by: frontegg-david <69419539+frontegg-david@users.noreply.github.com>
Co-authored-by: frontegg-david <69419539+frontegg-david@users.noreply.github.com>
Co-authored-by: frontegg-david <69419539+frontegg-david@users.noreply.github.com>
Co-authored-by: frontegg-david <69419539+frontegg-david@users.noreply.github.com>
* docs(codex): update Mintlify docs, CHANGELOG & READMEs [auto] * Delete docs/live/docs/guides/release-workflow.mdx * Update server.mdx --------- Co-authored-by: frontegg-david <69419539+frontegg-david@users.noreply.github.com>
Release v0.4.0
Summary by CodeRabbit
Release Notes
New Features
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.