Home Docs Claude Documentation

One capture · claude-docs

One read of Claude Documentationclaude-docs-20261015T150708Z

2 pages moved out of 266 read.

Pages moved 2 significant first

Pages read 266 in this capture

Captured 15 Oct 2026 15:07 UTC

Corpus hash 87a58a6ff22e corpus-hash

What this read moved

1-2 of 2

office-agents/opentelemetry Changed · +63 / -18 lines

from line 18

1818each model call, each tool execution, file uploads, and context

1919compaction.

2020

21All span attributes are included. They carry user-generated content:

21For the setups described under [Set up the collector](#set-up-the-collector),

22all span attributes are included. They carry user-generated content:

2223prompt text, tool inputs and outputs, and document URLs. The allowlist

2324filter that strips sensitive attributes on the Anthropic path does not

2425run on this path. One normalization still applies: MCP connector tool

2526names are recorded as the literal `mcp_tool` rather than the

26connector-specific name. Assistant response text is not included in

27span data. Your organization owns the collected data; treat the

27connector-specific name. For these setups, assistant response text is

28not included. Your organization owns the collected data; treat the

2829endpoint as containing prompt and document content when you scope

2930access controls and retention.

3031

32When the collector is instead delivered by an administrator-managed

33settings document, such as the one Claude for Government delivers, the

34add-in follows that document: it includes only the content categories

35the administrator selected, sends one log record per prompt, model call,

36and tool call to `{your_url}/v1/logs`, and sends the spans only while

37the administrator has turned traces on.

39One of those categories is Claude's responses: when selected, the reply

40is recorded as `response` on each model call's span and sent as its own

41log record, `office_agent.assistant_response`. Each turn's spans and log

42records also name the signed-in member as `user.email` and

43`user.account_uuid`, and with a Claude for Government sign-in the

44organization as `organization.id`, except a model call Claude makes while

45running a tool, which is reported with the model and token counts only.

47The add-in sends these log records to such a collector:

49| Log record | Sent for |

50| - | - |

51| `office_agent.user_prompt` | Each prompt |

52| `office_agent.api_request` | Each model call that completes |

53| `office_agent.api_error` | Each model call that is refused, fails, is cut off, or that the user stops |

54| `office_agent.assistant_response` | Each completed model call whose reply contains text, when the Claude's responses category is selected |

55| `office_agent.tool_result` | Each tool call |

57Auxiliary model calls the add-in makes for itself, such as context

58compaction (the `agent.compaction` span), the short progress headline

59shown while Claude works, and connection checks, yield no log record.

61Every record except `office_agent.assistant_response` carries

62`event.name`, `duration_ms`, and the attributes of the span it reports,

63as listed in the [span reference](#span-reference), minus tool output

64and the reply text. `office_agent.assistant_response` carries

65`event.name`, the reply as `response` and `response_chars`, `model`,

66`request_id`, and the same surface, session, member, and organization

67attributes as its model call.

3169Metrics are not sent to custom collectors. The `office_agent.*` counter

3270namespace routes to Anthropic only. Every counter increment is also

3371recorded as a span event on the active span, so the same signals are

3472recoverable from the trace stream.

3573

36Telemetry is sent over OTLP/HTTP to `{your_url}/v1/traces`. gRPC is not

37supported because of Office WebView constraints.

74Telemetry is sent over OTLP/HTTP to `{your_url}/v1/traces`, and the log

75records above to `{your_url}/v1/logs`. gRPC is not supported because of

76Office WebView constraints.

3877

3978## Endpoint requirements

4079

from line 153

114153

115154### Attribute size cap

116155

117Prompt, tool-input, and tool-output attributes are truncated in the

118add-in at 4,000 characters each by default and marked with a trailing

119`…[truncated]`. Set the `otlp_attr_max_chars` configuration key to a

156Prompt, reply, tool-input, and tool-output attributes are truncated in

157the add-in at 4,000 characters each by default and marked with a

158trailing `…[truncated]`. Set the `otlp_attr_max_chars` configuration key to a

120159positive integer to change the cap. Values are clamped to between 256

121160and 32,000. Before raising the cap, confirm your collector and tracing

122161backend accept attribute values of the configured size: many backends

from line 181

142181Each user turn produces up to five span types. `agent.query` is the

143182root; `agent.stream` and `agent.compaction` are its children;

144183`agent.tool_execution` is a child of `agent.stream`; `file.upload`

145arrives as a separate root span. The `agent.query` and

146`agent.compaction` spans carry `agent.surface` (`sheet`, `doc`,

147`slide`, or `mail`) and `agent.vendor` (`m` for Microsoft); the other

148three do not. To filter those by surface, join `agent.stream` and

149`agent.tool_execution` to their parent `agent.query` by trace ID, and

150correlate `file.upload` to a turn by `session.id` and timestamp, since

151it has its own trace ID and no surface attribute. Attributes marked

184arrives as a separate root span. The four `agent.*` spans each carry

185`agent.surface` (`sheet`, `doc`, `slide`, or `mail`), `agent.vendor`

186(`m` for Microsoft), and `session.id`, and with Claude sign-in

187`user.email`, `user.account_uuid`, and `organization.id`, so each

188can be filtered on its own. `file.upload` carries `session.id` and, with

189Claude sign-in, `user.email`; correlate it to a turn by `session.id` and

190timestamp, since it has its own trace ID. Attributes marked

152191*content* carry user-generated data. Attributes marked *Claude sign-in

153192only* are populated only when users sign in with a Claude account.

193Attributes marked *managed settings document only* are sent only to a

194collector delivered by an administrator-managed settings document, and

195only when the administrator selected the attribute's category, as

196described under [What the collector receives](#what-the-collector-receives).

154197

155198### Resource attributes

156199

from line 247

204247| `cache_creation_tokens` | Tokens written to prompt cache |

205248| `stop_reason` | `end_turn`, `tool_use`, `max_tokens`, and similar |

206249| `request_id` | Provider request ID for support correlation |

250| `response` *content, managed settings document only* | Text of Claude's reply (its text blocks), truncated per the attribute cap |

251| `response_chars` *managed settings document only* | Full reply length in characters, sent with `response` |

252| `error.name` | On failure, the exception class name (`APIUserAbortError` when the user stops the call; `Aborted` when the add-in abandons the call to retry it or because the conversation was reset) |

207253

208254The add-in requests prompt caching on every call. Cache token attributes

209255are set from the provider's response and omitted when the provider does

from line 281

235281

236282One span per automatic conversation summarization when context nears

237283the window limit, child of `agent.query`. SpanKind `CLIENT`. Also

238carries `agent.surface`, `agent.vendor`, `session.id`,

239`office.platform`, `office.version`, and `user.email` (Claude sign-in

240only).

284carries `office.platform` and `office.version` beside the identity

285attributes the other `agent.*` spans carry.

241286

242287| Attribute | Description |

243288| - | - |

office-agents/outlook Changed · +28 / -8 lines

from line 49

4949

5050<Steps>

5151 <Step title="Open the marketplace listing">

52 Go to the [Claude for Outlook listing on Microsoft AppSource](https://appsource.microsoft.com/).

52 Go to the [Claude for Outlook listing on Microsoft AppSource](https://marketplace.microsoft.com/en-us/product/office/WA200010724?tab=Overview).

5353 </Step>

5454

5555 <Step title="Install the add-in">

from line 186

186186

187187The redirect to `pivot.claude.ai` after consent carries only the consent

188188outcome, never a token or authorization code. See

189[Why sign-in redirects through pivot.claude.ai](/docs/office-agents/third-party-platforms#why-sign-in-redirects-through-pivotclaudeai)

189[Why sign-in redirects through pivot.claude.ai](/docs/office-agents/third-party-platforms#why-sign-in-redirects-through-pivot-claude-ai)

190190for what each redirect carries and how to verify it in a network capture.

191191

192192#### Use your own Entra app instead

from line 216

216216 Select "Grant admin consent" for your tenant.

217217 </Step>

218218

219 <Step title="Append the client ID to the manifest URL">

220 Copy the application's client ID from the Overview page. Append

221 `?graph_client_id=YOUR_CLIENT_ID` to the manifest URL from the

219 <Step title="Add the client ID to the manifest">

220 Copy the application's client ID from the Overview page. Download the

221 manifest from the

222222 [Install from a manifest file](#install-from-a-manifest-file) section

223 and use that URL when downloading the manifest.

223 and open it in a text editor. Search for `https://pivot.claude.ai/?m=`.

224 At the end of every URL that starts this way, inside the quotation

225 marks, add `&graph_client_id=YOUR_CLIENT_ID`. Lines that refer to a

226 URL by `resid` need no change, and neither do the icon or support

227 URLs. Save the file, then upload and deploy it as that section

228 describes.

224229 </Step>

225230</Steps>

226231

232The following example shows one edited line. The version number in your

233file can differ. Type `&` exactly as shown: an XML file cannot contain

234`&` on its own.

235

236```xml theme={null}

237<bt:Url id="Taskpane.Url" DefaultValue="https://pivot.claude.ai/?m=outlook-1.0.0.5&graph_client_id=YOUR_CLIENT_ID"/>

238```

239

227240With this option, skip the admin consent link entirely. Users do not see a

228241Microsoft permissions prompt because your tenant has already consented to

229242your own application.

230243

244If you deploy through a third-party platform and generate your manifests

245with the [setup wizard](/docs/office-agents/third-party-platforms#run-the-setup-wizard),

246provide the client ID to the wizard as `graph_client_id` instead of

247editing the file. See

248[Deploy to Outlook](/docs/office-agents/third-party-platforms#deploy-to-outlook).

249

231250### Deploy in a US Government or national cloud

232251

233252If your Microsoft 365 tenant is in GCC High, DoD, or 21Vianet, register

from line 261

242261| DoD | `us-gov-dod` |

243262| 21Vianet (China) | `china` |

244263

245For a DoD tenant the manifest URL ends with:

264For a DoD tenant, every URL in the manifest that starts with

265`https://pivot.claude.ai/?m=` ends with:

246266

247267```

248?graph_client_id=YOUR_CLIENT_ID&graph_cloud=us-gov-dod

268&graph_client_id=YOUR_CLIENT_ID&graph_cloud=us-gov-dod

249269```

250270

251271For GCC High and 21Vianet tenants, `graph_cloud` may be omitted: the