improve: fix docs skill title, clarify mcp.json placeholders, add installation steps to README#2
Open
yaron-reichert-cld wants to merge 1 commit intocloudinary-devs:mainfrom
Conversation
…tall steps to README
Three usability issues identified during plugin testing:
1. cloudinary-docs/SKILL.md had a "# My Skill" placeholder title left
over from the skill template — replaced with the correct title.
2. mcp.json credential placeholders ("cloud_name", "api_key",
"api_secret") looked like real values rather than placeholders.
Renamed to "YOUR_CLOUD_NAME" / "YOUR_API_KEY" / "YOUR_API_SECRET"
to make it obvious these must be replaced.
3. README "Getting Started" step 1 said "Install this plugin in
Cursor/Claude Code" with no instructions on how. Added step-by-step
installation instructions for both Cursor and Claude Code, plus
five example prompts to help users get started quickly.
Made-with: Cursor
Comment on lines
+32
to
+46
| ### Cursor | ||
|
|
||
| 1. Copy the contents of `mcp.json` into your project's `.cursor/mcp.json` (create the file if it doesn't exist). | ||
| 2. Copy the `skills/` directory into your project root. | ||
| 3. In `.cursor/rules/`, create one rule file per skill — each pointing to its `SKILL.md`. Cursor will use the rule description to decide when to invoke the skill. | ||
| 4. For `cloudinary-mediaflows`, replace `YOUR_CLOUD_NAME`, `YOUR_API_KEY`, and `YOUR_API_SECRET` in `mcp.json` with your Cloudinary credentials (found in the [Cloudinary Console](https://console.cloudinary.com/settings/api-keys)). | ||
| 5. On first use, approve the OAuth login prompt that Cursor shows for the other four MCP servers. | ||
|
|
||
| ### Claude Code | ||
|
|
||
| 1. Run: `claude --plugin-dir /path/to/cloudinary-plugin` | ||
| 2. For `cloudinary-mediaflows`, replace the credential placeholders in `mcp.json` before starting. | ||
| 3. On first use, complete the OAuth login for the other four MCP servers. | ||
|
|
||
| Once installed, ask your agent anything about Cloudinary — uploads, transformations, metadata, analysis, and more. The agent will automatically use the right skill and MCP server for the job. |
Collaborator
There was a problem hiding this comment.
This entire section is incorrect. Both Cursor/Claude have a marketplace included, and the installation is built in inside.
| # Cloudinary Documentation Skill | ||
|
|
||
| Helps developers to integrate Cloudinary into their applications by providing documentation and code examples retrieved directly from the optimized .md files in the Cloudinary documentation rather than having parse the HTML pages. | ||
| Helps developers integrate Cloudinary into their applications by providing documentation and code examples retrieved directly from the optimized .md files in the Cloudinary documentation, rather than having to parse HTML pages. |
Collaborator
There was a problem hiding this comment.
Actually the original is an awful description all together (bad work on Cursor's part lol being too honest).
Let's change to:
Suggested change
| Helps developers integrate Cloudinary into their applications by providing documentation and code examples retrieved directly from the optimized .md files in the Cloudinary documentation, rather than having to parse HTML pages. | |
| Helps developers integrate Cloudinary into their applications by providing documentation and code examples. |
Member
There was a problem hiding this comment.
@sveta-slepner - Do we want to be a bit more specific on what it does than just "providing"? - i.e.
Ensures that the relevant pages from the latest version of the Cloudinary documentation, including code examples from all supported SDKs, are included in the context whenever asking any question relating to Cloudinary
Collaborator
There was a problem hiding this comment.
Feel free to change to whatever you see fit. It was generated by Cursor :)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three usability issues found during testing that would confuse new users or the agent itself.
Fix 1 —
cloudinary-docsskill: remove# My Skillplaceholder titleskills/cloudinary-docs/SKILL.mdhad a leftover template heading# My Skillinstead of a real title. Changed to# Cloudinary Documentation Skill. Small but it looks unprofessional and could confuse an agent that reads the skill name vs its H1.Fix 2 —
mcp.json: credential placeholders look like real valuesBefore:
After:
The original values (
"cloud_name","api_key","api_secret") read like real credentials rather than placeholders. New users would likely paste this file and be confused why MediaFlows doesn't authenticate.Fix 3 — README: add actual installation instructions and example prompts
Before: Step 1 simply said "Install this plugin in Cursor/Claude Code" — no guidance on how.
After: Added step-by-step instructions for both Cursor (copy
mcp.json, copyskills/, create rules) and Claude Code (--plugin-dir). Also added 5 example prompts to help users understand what they can ask immediately after installing.How this was found
Identified during a test run of the plugin, focusing on the first-time user experience and agent configuration quality.
Made with Cursor