Skip to content

Commit c7155e8

Browse files
authored
add prose for insiders docs about fields
1 parent 457f599 commit c7155e8

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

docs/insiders-features.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,47 @@ Because this changes list tool response shape, clients that require JSON list re
161161

162162
---
163163

164+
## Issue fields
165+
166+
Issue fields are custom fields attached to issues in GitHub repositories, such as single-select options, text fields, number fields, and date fields.
167+
168+
### `search_issues` — always returns field values
169+
170+
Every `search_issues` result includes a `field_values` array regardless of whether Insiders Mode is on. Each entry has a `field_name` and a human-readable `value`:
171+
172+
```json
173+
{
174+
"field_values": [
175+
{ "field_name": "Priority", "value": "High" },
176+
{ "field_name": "Due date", "value": "2025-09-30" }
177+
]
178+
}
179+
```
180+
181+
Issues with no custom field values set will have an empty or absent `field_values` array.
182+
183+
### `issue_read` — field values included in Insiders Mode
184+
185+
When Insiders Mode is on, the `issue_read` response includes a `field_values` array in the same format as `search_issues`. Issues with no values set will omit the field.
186+
187+
### `issue_write` — setting and clearing field values (Insiders Mode)
188+
189+
Pass an `issue_fields` array to set or clear custom field values on create or update. Each entry requires `field_name` and exactly one of:
190+
191+
- `field_option_name` — for single-select fields (validated against the field's options before the API call; preferred over `value` for single-select)
192+
- `value` — for text, number, and date fields (`YYYY-MM-DD` for dates)
193+
- `delete: true` — to clear the field's current value
194+
195+
On update, the server fetches the issue's existing field values and merges your entries in: fields you provide override their current value, and fields you omit are left unchanged.
196+
197+
### `list_issues` — filtering by field values (Insiders Mode)
198+
199+
Pass a `field_filters` array to filter results by custom field values. Each entry takes a `field_name` and a `value` string; the server resolves the field's data type and coerces the value accordingly (option name for single-select, plain text, number, or `YYYY-MM-DD` date). Field name matching is case-insensitive. Multiple filters are combined with AND logic.
200+
201+
Each item in the response also includes a `field_values` array in the same format as `search_issues`.
202+
203+
---
204+
164205
## How feature flags are resolved
165206

166207
> [!NOTE]

0 commit comments

Comments
 (0)