Skip to content
Leverage AI Developer Support

OneNote Connector

Use this page when you need the Microsoft-side setup details for the OneNote connector. For shared connector behavior, start with Connectors Overview and Provider Auth And Setup.

Runtime Shape

Section titled “Runtime Shape”
  • Runtime status: implemented, live-only, read-only
  • Connector key: onenote
  • Live domain and canonical tool: knowledge-page through knowledge-page-live-query
  • Auth binding: Better Auth generic OAuth provider id microsoft
  • Callback URI examples:
    • http://localhost:3001/api/auth/oauth2/callback/microsoft
    • https://auth.example.com/api/auth/oauth2/callback/microsoft
  • Setup console URL:
  • Required connector scopes:
    • Notes.Read.All
  • Required resource selection:
    • Save selected OneNote notebooks through the shared connector resourceSelection model.
    • Sections are optional refinements after notebooks are selected.

Provider-Specific Gotchas

Section titled “Provider-Specific Gotchas”
  • OneNote uses Microsoft Graph v1.0 delegated OneNote APIs. It reads /me/onenote/notebooks, section groups, sections, pages, scoped page lists, page details, and bounded page HTML/text content.
  • OneNote app-only auth is not supported.
  • Deprecated OneNote get-pages?search behavior is not used. If a tenant has weak full-text page search, the live path performs bounded title/recent/page-content retrieval and discloses bounded coverage instead of claiming whole-notebook semantic recall.
  • Page HTML/text evidence is transient live grounding. Do not add indexed sync, Meltano taps, embeddings, create/update/write behavior, media extraction, or retained notebook/page content until a separate accepted design adds them.
  • OneNote shares the microsoft OAuth provider with OneDrive, Outlook, Microsoft Calendar, Microsoft Contacts, and SharePoint. Reauthorization should preserve active sibling scopes, but selected notebooks are connector-level scoped resources, not account-level Microsoft provider-family scopes.

Real-Provider Smoke

Section titled “Real-Provider Smoke”

apps/api/.env.example documents the OneNote smoke fixture variables:

  • REAL_PROVIDER_E2E_ONENOTE_ACCOUNT_ID
  • REAL_PROVIDER_E2E_ONENOTE_NOTEBOOK_ID
  • optional REAL_PROVIDER_E2E_ONENOTE_NOTEBOOK_IDS for extra selected notebooks
  • optional page/title/query pins for stronger assertions

Use the real-provider doctor/smoke lane without printing secrets or reading real .env files manually.

Canonical Sources

Section titled “Canonical Sources”
  • packages/domain/src/connectors/connectorRegistry.ts
  • apps/api/src/connectors/providerManifests.ts
  • apps/api/src/connectors/oneNoteLiveAdapters.ts
  • apps/api/src/connectors/providerOptions.ts
  • docs/features/connectors/spec.md
  • docs/features/live-query/spec.md

Official Docs

Section titled “Official Docs”