Skip to content

Commit 010c127

Browse files
tilenkavcicrohan-devrevkunal-mohta-99bc-devrevAtul-Butola
authored
fix: Remove reference to by field (#284)
* Update MCP files description * Remove reference to by field * Update proguard troubleshooting guide (#281) * PLuG user identification docs improvements (#279) * PLuG user identification docs improvements * address review comments * diagram font * Revert "diagram font" This reverts commit 5af9512. * diagram font * Update fern/docs/pages/sdks/web/user-identity.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update fern/docs/pages/sdks/web/user-identity.mdx Co-authored-by: Ben Colborn <[email protected]> * update font --------- Co-authored-by: Ben Colborn <[email protected]> Co-authored-by: Atul-Butola <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * chore: update session ingestion URLs (#282) * Nit * Nit * Update fern/docs/pages/airdrop/mcp.mdx --------- Co-authored-by: Rohan Gupta <[email protected]> Co-authored-by: Kunal Mohta <[email protected]> Co-authored-by: Ben Colborn <[email protected]> Co-authored-by: Atul-Butola <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 6ed2995 commit 010c127

File tree

2 files changed

+7
-39
lines changed

2 files changed

+7
-39
lines changed

fern/docs/pages/airdrop/mcp.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,10 @@ Testing shows good results with Cursor and Claude Code. The AI can prepare initi
1616
- Chef-cli installed and configured
1717
- MCP-compatible client (Cursor, Claude Code, etc.)
1818
- External domain metadata file
19-
- Empty or partially populated initial domain mapping file
2019

2120
## Configuration
2221

23-
Create a `.mcp.json` file with the following content:
22+
Create a `mcp.json` file with the following content:
2423

2524
```json
2625
{
@@ -38,7 +37,9 @@ Create a `.mcp.json` file with the following content:
3837
### Cursor setup
3938

4039
1. Provide `.cursor/mcp.json` in your project root.
41-
2. Using the editor Agent mode point the AI to the initial domain mapping file.
40+
2. Using the editor Agent mode point the AI to the preferred initial domain mapping file location.
41+
- For best results, mention that file paths should be absolute.
42+
- Alternatively, you can provide an existing initial domain mapping file.
4243
3. Use the editor to guide the AI to create the initial domain mappings.
4344
4. Use `initial-mapping check` to test the initial domain mappings against the local domain metadata file.
4445

@@ -51,7 +52,8 @@ See [Cursor documentation](https://docs.cursor.com/context/@-symbols/@-docs#add-
5152
### Claude Code setup
5253

5354
1. Provide `.mcp.json` in your project root.
54-
2. Using the editor point the AI to the initial domain mapping file.
55+
2. Using the editor point the AI to the preferred initial domain mapping file location.
56+
- Alternatively, you can provide an existing initial domain mapping file.
5557
3. Use the editor to guide the AI to create the initial domain mappings.
5658
4. Use `initial-mapping check` to test the initial domain mappings against the local domain metadata file.
5759

@@ -86,4 +88,3 @@ The MCP server provides tools for:
8688
- Field mapping and unmapping operations
8789
- Validation of mapping file structure
8890
- Testing initial domain mapping files against local metadata files
89-

fern/docs/pages/airdrop/metadata-extraction.mdx

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -364,45 +364,12 @@ be changed by the end user at any time, such as mandatory fields or custom field
364364
}
365365
```
366366

367-
- Some references have the role of parent or child.
367+
Some references have the role of parent or child.
368368
This means that the child record doesn't make sense without its parent, for example a comment
369369
attached to a ticket.
370370
Assigning a `reference_type` helps Airdrop correctly handle such fields in case the end-user
371371
decides to filter some of the parent records out.
372372

373-
- Sometimes the external system uses references besides the primary key of records, for example
374-
when referring to a case by serial number, or to a user by their email.
375-
To correctly resolve such references, they must be marked with `by_field`, which must be a field
376-
existing in that record type, marked `is_identifier`. For example:
377-
```json {7,16-20}
378-
{
379-
"record_types": {
380-
"users": {
381-
"fields": {
382-
"email": {
383-
"type": "text",
384-
"is_identifier":true
385-
}
386-
}
387-
},
388-
"comments": {
389-
"fields": {
390-
"user_email": {
391-
"type": "reference",
392-
"reference": {
393-
"refers_to": {
394-
"#record:users": {
395-
"by_field": "email"
396-
}
397-
}
398-
}
399-
}
400-
}
401-
}
402-
}
403-
}
404-
```
405-
406373
### Define field attributes
407374

408375
External system fields that shouldn't be mapped in reverse should be marked as `is_read_only`.

0 commit comments

Comments
 (0)