-
-
Notifications
You must be signed in to change notification settings - Fork 6
update Flutter version in CI workflow and expand Cristalyse MCP server setup docs #80
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings. WalkthroughUpdated GitHub Actions CI to use Flutter 3.38.5 (was 3.38.0). Rewrote MCP server docs: replaced the single combined "AI Code Editor" tab with an Antigravity command-based tab and added separate Cursor, Windsurf, and Warp static-URL tabs. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Possibly related PRs
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (2)
🔇 Additional comments (3)
Comment |
…P server setup docs
5af7f1a to
d54a552
Compare
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: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
.github/workflows/test.yml(1 hunks)doc/cristalyse-mcp-server.mdx(1 hunks)
🔇 Additional comments (3)
doc/cristalyse-mcp-server.mdx (2)
39-51: The Cursor MCP configuration format using theurlfield is correct and matches Cursor's documented schema for remote MCP servers. This configuration is valid and requires no changes.
23-38: The Antigravity mcp-remote command configuration is correct. The format matches the official mcp-remote documentation and is compatible with Antigravity's local/exec server configuration. The URL for Cristalyse's MCP endpoint is correct. No changes required..github/workflows/test.yml (1)
20-20: Flutter 3.38.5 is a valid patch release on the stable channel. This routine maintenance bump is safe to merge.
| <Tab title="Windsurf"> | ||
| Add the following configuration to your MCP settings file: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "cristalyse_docs": { | ||
| "url": "https://docs.cristalyse.com/mcp" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| </Tab> | ||
| <Tab title=" Warp "> | ||
| Add the following configuration to your MCP settings file: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "cristalyse_docs": { | ||
| "url": "https://docs.cristalyse.com/mcp" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| </Tab> |
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.
🧩 Analysis chain
🌐 Web query:
Windsurf MCP server configuration format documentation
💡 Result:
Summary — Windsurf MCP server config format
- File: mcp_config.json (typically in ~/.codeium/windsurf/mcp_config.json on macOS/Linux; Windows path under %USERPROFILE%.codeium\windsurf). [1][2]
- Top-level structure:
{
"mcpServers": {
"": { ... },
...
}
}.[1][6] - Server entry options (common fields):
- command: executable to run (e.g., "npx", "docker", "python3"). [1][2]
- args: array of arguments for the command. [1][6]
- env: object of environment variables. [1][2]
- serverUrl: for HTTP MCP servers (use full endpoint like https://your-server/mcp). [1]
- headers / metadata: some integrations allow HTTP headers or metadata fields for auth/description. [5]
- transport types supported: "stdio" and "http" (streamable HTTP and MCP auth supported). [1]
- Admin whitelist notes: Windsurf supports exact-match or regex-based whitelist rules for command/args; arrays must match length and regexes may be used to allow flexibility. [1][2]
- Example (command-based):
{
"mcpServers": {
"github": {
"command": "npx",
"args": ["-y","@modelcontextprotocol/server-github"],
"env": {"GITHUB_PERSONAL_ACCESS_TOKEN":""}
}
}
}.[1] - Example (HTTP server):
{
"mcpServers": {
"figma": {
"serverUrl": "https:///mcp"
}
}
}.[1]
Sources
[1] Windsurf / Cascade MCP integration docs — mcp_config.json examples & field descriptions.
[2] Windsurf docs (alternate page) — file path, examples, whitelist/regex rules.
[3] Mixedbread setup guide — mcp_config.json path & creation instructions.
[4] Probo integration docs — example HTTP/headers/metadata config for Windsurf.
(If you want, I can paste a ready-to-use mcp_config.json template for a specific MCP server or your environment.)
🌐 Web query:
Warp MCP server configuration format and schema
💡 Result:
Summary — format and schema (Warp MCP servers)
-
File format: JSON. Configs can be pasted into Warp’s MCP Servers UI or stored in a JSON file (examples use a top-level object). [1][2][3]
-
Top-level shape (common patterns):
- Either:
- {"mcpServers": { "": { ... } , ... }} (used in Warp examples), or
- { "": { ... } , ... } (supported by some MCP tools/clients). [1][2][3]
- Either:
-
Per-server object schema (fields shown in Warp docs and examples):
- command (string) — executable to run (required for CLI servers). [1][2]
- args (string[]) — array of command-line arguments. [1][2]
- env (object) — key/value environment variables (optional; sensitive values may be scrubbed when sharing). [1]
- working_directory (string|null) — working dir for the command (optional; recommended when args use relative paths). [1]
- start_on_launch (boolean) — optional flag in some MCP docs to auto-start the server. [3]
- (For SSE/remote servers) the args commonly include a remote SSE URL (e.g., mcp-remote https://…/sse). [2]
-
Example (from Warp docs):
{
"mcpServers": {
"linear": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.linear.app/sse"],
"env": {},
"working_directory": null
}
}
} [2] -
Notes:
- CLI servers run the given command and Warp manages start/stop. SSE/URL servers typically use an mcp-remote client argument. [1][2]
- When sharing configs, Warp will scrub secrets from env and prompt for them on install. [1]
- Some third-party MCP implementations/doc pages show the alternative root (no "mcpServers") and the same per-server object fields — both patterns are in common use. [3]
Sources
[1] Warp docs — Model Context Protocol (MCP) (MCP Servers page).
[2] Warp University — Linear MCP tutorial (JSON example).
[3] MCP-hub / examples (mcp_servers.json example).
Use correct field names for MCP server configuration.
The "url" field is not supported by either tool. Windsurf requires "serverUrl" for HTTP MCP servers; Warp uses "command" and "args" for CLI servers or mcp-remote in args for remote/SSE servers. Update both configurations to match the official schema.
🤖 Prompt for AI Agents
doc/cristalyse-mcp-server.mdx lines 52-77: both example MCP server entries use
an unsupported "url" field; update the Windsurf example to use "serverUrl" for
an HTTP MCP server, and update the Warp example to use the CLI schema (provide
"command" and "args") — for a remote/SSE Warp configuration include "mcp-remote"
in the args array (or use the appropriate CLI invocation), ensuring keys match
the official schema (Windsurf: serverUrl; Warp: command and args with mcp-remote
when targeting remote/SSE).
| <Tab title=" Warp "> | ||
| Add the following configuration to your MCP settings file: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "cristalyse_docs": { | ||
| "url": "https://docs.cristalyse.com/mcp" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| </Tab> |
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.
Fix tab title spacing and JSON indentation in Warp tab.
Line 65 has extra spaces in the tab title: " Warp " should be "Warp" to match the formatting of other tabs. Additionally, line 72 has inconsistent indentation before the "url" field (extra space), which should be aligned with the Cursor tab (line 46).
Apply this diff to fix both the tab title spacing and JSON indentation:
- <Tab title=" Warp ">
+ <Tab title="Warp">
Add the following configuration to your MCP settings file:
```json
{
"mcpServers": {
"cristalyse_docs": {
- "url": "https://docs.cristalyse.com/mcp"
+ "url": "https://docs.cristalyse.com/mcp"
}
}
}
```
</Tab>🤖 Prompt for AI Agents
In doc/cristalyse-mcp-server.mdx around lines 65 to 77, fix the extra spaces in
the Tab title and the JSON indentation: change the Tab title from " Warp " to
"Warp" (no leading/trailing spaces) and realign the "url" property by adding one
additional space so it lines up with the other properties (match indentation
used in the Cursor tab), ensuring the JSON block has consistent indentation.
No description provided.