feat: add glama.json and move setup to the top of README #46
Conversation
* fix: added build check workflow * chore: typo fixes
WalkthroughDocumentation updates are introduced to README.md, adding a Usage section with configuration parameters (PLANE_API_KEY, PLANE_WORKSPACE_SLUG, PLANE_API_HOST_URL) and JSON configuration examples for Claude Desktop and VSCode integration. A new glama.json configuration file with schema reference and maintainer information is added. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
README.md (1)
83-384: Address systematic Markdown indentation inconsistencies (optional refactor).The Markdown linter flagged multiple unordered list indentation issues (MD007) and inconsistent indentation (MD005) throughout the Tools section. The indentation varies between 2, 3, 4, 5, 6, 7, and 8 spaces where it should be consistently 2 spaces per level.
Examples of affected ranges:
- Lines 101–103: Actual indentation 4 spaces, expected 2
- Lines 116–117: Mixed 7–8 spaces, expected 6
- Lines 147–158: Inconsistent 3–5 spaces at same level
- Lines 226–227, 309–311: Similar issues
Consider running a Markdown formatter (e.g.,
prettier --write README.md) to auto-correct indentation throughout this section. Since this is a cosmetic/linting issue rather than a content problem, it can be deferred if time-constrained.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(2 hunks)glama.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~206-~206: Ensure spelling is correct
Context: ...e_identifier` (string, required): Issue numbe: Project identifier (e.g., "PROJ") r (e....
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
README.md
29-29: Bare URL used
(MD034, no-bare-urls)
101-101: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
102-102: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
103-103: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
108-108: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
109-109: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
116-116: Unordered list indentation
Expected: 6; Actual: 7
(MD007, ul-indent)
117-117: Inconsistent indentation for list items at the same level
Expected: 7; Actual: 8
(MD005, list-indent)
117-117: Unordered list indentation
Expected: 6; Actual: 8
(MD007, ul-indent)
147-147: Inconsistent indentation for list items at the same level
Expected: 2; Actual: 3
(MD005, list-indent)
147-147: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
148-148: Unordered list indentation
Expected: 4; Actual: 5
(MD007, ul-indent)
149-149: Unordered list indentation
Expected: 4; Actual: 5
(MD007, ul-indent)
150-150: Unordered list indentation
Expected: 6; Actual: 8
(MD007, ul-indent)
151-151: Unordered list indentation
Expected: 6; Actual: 8
(MD007, ul-indent)
154-154: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
155-155: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
156-156: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
157-157: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
158-158: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
226-226: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 5
(MD005, list-indent)
226-226: Unordered list indentation
Expected: 4; Actual: 5
(MD007, ul-indent)
227-227: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 6
(MD005, list-indent)
227-227: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
309-309: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 5
(MD005, list-indent)
309-309: Unordered list indentation
Expected: 4; Actual: 5
(MD007, ul-indent)
310-310: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 6
(MD005, list-indent)
310-310: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
311-311: Inconsistent indentation for list items at the same level
Expected: 4; Actual: 6
(MD005, list-indent)
311-311: Unordered list indentation
Expected: 4; Actual: 6
(MD007, ul-indent)
🔇 Additional comments (2)
glama.json (1)
1-4: LGTM!The glama.json file correctly follows the format with $schema and maintainers properties. The structure aligns with the standard Glama registry configuration.
README.md (1)
23-78: Well-structured Usage section.The new Usage section with configuration parameters, Claude Desktop and VSCode setup examples is clear, comprehensive, and well-formatted. The environment variable mappings and JSON configuration blocks are helpful for users integrating with Plane MCP.
|
|
||
| - `PLANE_API_KEY` - Your Plane API token. You can generate one from the Workspace Settings > API Tokens page (`/settings/api-tokens/`) in the Plane app. | ||
| - `PLANE_WORKSPACE_SLUG` - The workspace slug for your Plane instance. The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. | ||
| - `PLANE_API_HOST_URL` (optional) - The host URL of the Plane API Server. Defaults to https://api.plane.so/ |
There was a problem hiding this comment.
Wrap bare URL in angle brackets.
Line 29 has a bare URL that should be wrapped for proper Markdown formatting:
-- `PLANE_API_HOST_URL` (optional) - The host URL of the Plane API Server. Defaults to https://api.plane.so/
+- `PLANE_API_HOST_URL` (optional) - The host URL of the Plane API Server. Defaults to <https://api.plane.so/>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - `PLANE_API_HOST_URL` (optional) - The host URL of the Plane API Server. Defaults to https://api.plane.so/ | |
| - `PLANE_API_HOST_URL` (optional) - The host URL of the Plane API Server. Defaults to <https://api.plane.so/> |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
29-29: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In README.md around line 29 the bare URL "https://api.plane.so/" should be
wrapped in angle brackets for correct Markdown formatting; update the text to
enclose the URL in <https://api.plane.so/> so the link renders properly without
affecting the surrounding sentence.
Description
Summary by CodeRabbit
Release Notes