-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
docs: Added AI Integration section to use parse-mcp to help AI Agents interact with Parse #9949
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
Open
R3D347HR4Y
wants to merge
3
commits into
parse-community:alpha
Choose a base branch
from
R3D347HR4Y:alpha
base: alpha
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+162
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| # AI Integration for Parse Server | ||
|
|
||
| This document describes how AI agents and LLMs can interact with Parse Server databases. | ||
|
|
||
| ## Parse MCP Server | ||
|
|
||
| [Parse MCP Server](https://github.com/R3D347HR4Y/parse-mcp) is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that enables AI assistants to interact with Parse Server instances through natural language. | ||
|
|
||
| [](https://hub.docker.com/r/purpleshow/parse-mcp-server) | ||
| [](https://github.com/R3D347HR4Y/parse-mcp) | ||
|
|
||
| ### Features | ||
|
|
||
| | Category | Capabilities | | ||
| |----------|-------------| | ||
| | **Schema Exploration** | Get all schemas, inspect class structure, understand field types | | ||
| | **Data Querying** | Full Parse query syntax, pagination, sorting, pointer includes | | ||
| | **Relations** | Query and manage Pointer and Relation fields | | ||
| | **CRUD Operations** | Create, read, update, delete objects with safety prompts | | ||
| | **Batch Operations** | Bulk create, update, delete (max 50 per batch) | | ||
| | **Users & Roles** | Query users, list roles, get role members | | ||
| | **Cloud Code** | Execute Cloud Code functions | | ||
| | **Aggregation** | MongoDB-style aggregation pipelines | | ||
| | **Troubleshooting** | Validate pointers, find orphaned references, class statistics | | ||
| | **Configuration** | Read and update Parse Config | | ||
|
|
||
| ### Installation | ||
|
|
||
| #### Docker (Recommended) | ||
|
|
||
| ```bash | ||
| docker pull purpleshow/parse-mcp-server:latest | ||
|
|
||
| docker run -d -p 3000:3000 \ | ||
| -e PARSE_SERVER_URL="http://localhost:1337/parse" \ | ||
| -e PARSE_APP_ID="YOUR_APP_ID" \ | ||
| -e PARSE_MASTER_KEY="YOUR_MASTER_KEY" \ | ||
| purpleshow/parse-mcp-server:latest | ||
| ``` | ||
|
|
||
| #### npm | ||
|
|
||
| ```bash | ||
| npm install -g parse-mcp-server | ||
| ``` | ||
|
|
||
| ### IDE Configuration | ||
|
|
||
| #### Cursor | ||
|
|
||
| Add to `.cursor/mcp.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "parse": { | ||
| "command": "docker", | ||
| "args": [ | ||
| "run", "-i", "--rm", | ||
| "-e", "MCP_TRANSPORT=stdio", | ||
| "-e", "PARSE_SERVER_URL=http://localhost:1337/parse", | ||
| "-e", "PARSE_APP_ID=YOUR_APP_ID", | ||
| "-e", "PARSE_MASTER_KEY=YOUR_MASTER_KEY", | ||
| "purpleshow/parse-mcp-server:latest" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| #### Claude Desktop | ||
|
|
||
| Add to `claude_desktop_config.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "parse": { | ||
| "command": "docker", | ||
| "args": [ | ||
| "run", "-i", "--rm", | ||
| "-e", "MCP_TRANSPORT=stdio", | ||
| "-e", "PARSE_SERVER_URL=http://localhost:1337/parse", | ||
| "-e", "PARSE_APP_ID=YOUR_APP_ID", | ||
| "-e", "PARSE_MASTER_KEY=YOUR_MASTER_KEY", | ||
| "purpleshow/parse-mcp-server:latest" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Environment Variables | ||
|
|
||
| | Variable | Required | Description | | ||
| |----------|----------|-------------| | ||
| | `PARSE_SERVER_URL` | ✅ | Parse Server URL (e.g., `http://localhost:1337/parse`) | | ||
| | `PARSE_APP_ID` | ✅ | Your Parse Application ID | | ||
| | `PARSE_MASTER_KEY` | ⚠️ | Master Key for admin operations | | ||
| | `PARSE_JS_KEY` | ❌ | JavaScript Key (optional) | | ||
| | `MCP_TRANSPORT` | ❌ | `http` (default) or `stdio` | | ||
| | `MCP_PORT` | ❌ | HTTP port (default: 3000) | | ||
|
|
||
| ### Safety | ||
|
|
||
| The MCP server is designed with safety in mind: | ||
|
|
||
| - **Permission Prompts**: All data modification tools include warnings and suggest asking for user permission | ||
| - **Destructive Warnings**: Delete operations are clearly marked as dangerous | ||
| - **Sample-First Approach**: Encourages getting sample data before writing complex queries | ||
| - **Schema Awareness**: Suggests exploring schemas to understand data structure | ||
|
|
||
| ### Links | ||
|
|
||
| - **GitHub**: <https://github.com/R3D347HR4Y/parse-mcp> | ||
| - **Docker Hub**: <https://hub.docker.com/r/purpleshow/parse-mcp-server> | ||
| - **npm**: <https://www.npmjs.com/package/parse-mcp-server> | ||
|
|
||
| ## For AI Agents | ||
|
|
||
| If you are an AI agent exploring this repository: | ||
|
|
||
| 1. **To interact with a Parse Server database**, use the Parse MCP Server tools | ||
| 2. **Before querying**, use `get_all_schemas` to understand the database structure | ||
| 3. **Before complex queries**, use `get_sample_objects` to see actual data formats | ||
| 4. **Before modifying data**, always ask the user for permission | ||
| 5. **For troubleshooting**, use `validate_pointer` and `find_orphaned_pointers` | ||
|
|
||
| ### Recommended Workflow | ||
|
|
||
|
|
||
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.