-
Notifications
You must be signed in to change notification settings - Fork 3
enh: Add MCP documentation #235
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
7a1c8a2
Add mcp
tilenkavcic 8f8b219
Add link
tilenkavcic 874d9e8
Address comments
tilenkavcic a9bd3bf
Add other IDEs
tilenkavcic abb39e0
Move limitations to top
tilenkavcic ab0bfb0
Clarify export button
tilenkavcic 24aae7f
Nit
tilenkavcic 695bceb
Merge branch 'main' into tilenk/export-button
tilenkavcic 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
tilenkavcic marked this conversation as resolved.
Show resolved
Hide resolved
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
The Model Context Protocol (MCP) is an open protocol that enables large language models to interact with applications through standardized interfaces. | ||
|
||
Chef-cli provides MCP integration through the `chef-cli mcp initial-mapping` subcommand. | ||
This integration allows AI assistants to programmatically edit and test initial domain mapping files. | ||
|
||
## Limitations | ||
|
||
<Warning> | ||
MCP integration is experimental. Functionality may vary across different AI models and MCP clients. | ||
</Warning> | ||
|
||
Testing shows good results with Cursor and Claude Code. The AI can prepare initial mappings with significant autonomy, though developer oversight remains essential. | ||
|
||
## Prerequisites | ||
|
||
- Chef-cli installed and configured | ||
- MCP-compatible client (Cursor, Claude Code, etc.) | ||
- External domain metadata file | ||
- Empty or partially populated initial domain mapping file | ||
tilenkavcic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Configuration | ||
|
||
Create a `.mcp.json` file with the following content: | ||
|
||
```json | ||
{ | ||
"mcpServers": { | ||
"airdrop": { | ||
tilenkavcic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"command": "chef-cli", | ||
"args": [ | ||
"mcp initial-mapping" | ||
] | ||
} | ||
} | ||
} | ||
``` | ||
|
||
### Cursor setup | ||
|
||
1. Provide `.cursor/mcp.json` in your project root. | ||
2. Using the editor Agent mode point the AI to the initial domain mapping file. | ||
3. Use the editor to guide the AI to create the initial domain mappings. | ||
4. Use `initial-mapping check` to test the initial domain mappings against the local domain metadata file. | ||
|
||
### Claude Code setup | ||
|
||
1. Provide `.mcp.json` in your project root. | ||
2. Using the editor point the AI to the initial domain mapping file. | ||
3. Use the editor to guide the AI to create the initial domain mappings. | ||
4. Use `initial-mapping check` to test the initial domain mappings against the local domain metadata file. | ||
|
||
### Other IDEs | ||
|
||
You can use the same `.mcp.json` file in other IDEs that support MCP. | ||
|
||
## Usage guidelines | ||
|
||
To guide the AI tool, provide the following instructions to your AI assistant: | ||
|
||
```markdown | ||
When asked to perform airdrop initial mapping: | ||
|
||
- Refer to the `metadata.json` for the external domain metadata. | ||
- Use `mappings.json` as your initial domain mapping file. | ||
- Call 'use_mapping' to test out how the initial mapping behaves on the current metadata | ||
- Use MCP tools to manipulate the initial mapping when adding and removing record type mappings, or unmapping fields or mapping simple fields. | ||
For more complex field mappings you may edit the mapping file directly. | ||
Refer to the `initial_mappings_schema.yaml` for its proper format. | ||
- If doing so, always use 'use_mapping' to verify the mapping file is still valid. | ||
``` | ||
|
||
Adjust file paths according to your project structure. | ||
|
||
## Available operations | ||
|
||
The MCP server provides tools for: | ||
|
||
- Testing mappings against metadata | ||
- Adding and removing record type mappings | ||
- Field mapping and unmapping operations | ||
- Validation of mapping file structure | ||
- Testing initial domain mapping files against local metadata files | ||
|
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
Oops, something went wrong.
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.