Contract 1.7.0 · Local previewRead Markdown

get_adherence_summary

Returns Completed, Not Completed, and Unresolved counts and the adherence rate, overall and per Behavior, for a date range of up to 366 days. Adherence is Completed divided by Completed plus Not Completed. Unresolved Occurrences, including Needs decision, are excluded. It is null when nothing is resolved. Counts and the rate cover scheduled Occurrences; opportunity_completed_count counts added opportunities apart. Use it for “how am I doing” questions. Cadence does not compute streaks.

Permission and annotations

Required scope: cadence.read. Contract 1.7.0; available since 1.0.0.

  • title: “Get adherence summary”
  • readOnlyHint: true
  • destructiveHint: false
  • idempotentHint: true
  • openWorldHint: false

Reads account data and changes nothing, so readOnlyHint is true. Claude runs read-only tools without per-call confirmation, and OpenAI asks for readOnlyHint on every read. openWorldHint is false because the tool reaches only the user’s own Cadence account.

Input

Required means required within the containing object. Variant fields apply only to that variant; children of nullable values apply when non-null. Unknown fields are rejected.

Field Required Type Meaning and constraints
start_local_date yes string First local date, inclusive.; format: date
end_local_date yes string Last local date, inclusive.; format: date
behavior_ids no array Only these Behaviors.; minItems: 1; maxItems: 50; uniqueItems: true
behavior_ids[] yes string format: uuid

Output

Required means required within the containing object. Variant fields apply only to that variant; children of nullable values apply when non-null. Unknown fields are rejected.

Field Required Type Meaning and constraints
start_local_date yes string Calendar date (YYYY-MM-DD) in the account timezone.; format: date
end_local_date yes string Calendar date (YYYY-MM-DD) in the account timezone.; format: date
timezone yes string IANA timezone name.; minLength: 1; maxLength: 64; pattern: ^[A-Za-z0-9_+\-/]+$
adherence_definition yes string Value: Adherence is Completed divided by Completed plus Not Completed. Unresolved Occurrences, including Needs decision, are excluded. It is null when nothing is resolved.
overall yes object
overall.completed yes integer minimum: 0
overall.not_completed yes integer minimum: 0
overall.unresolved yes integer Includes Needs decision. Excluded from adherence.; minimum: 0
overall.needs_decision yes integer Unresolved Occurrences before today.; minimum: 0
overall.adherence_rate yes number or null Adherence is Completed divided by Completed plus Not Completed. Unresolved Occurrences, including Needs decision, are excluded. It is null when nothing is resolved.; minimum: 0; maximum: 1
overall.opportunity_completed_count yes integer Completed opportunity Occurrences, the ones added to a day. Counted apart: the other counts and adherence_rate cover scheduled Occurrences only (contract 1.6.0).; minimum: 0
behaviors yes array
behaviors[] yes object
behaviors[].behavior_id yes string format: uuid
behaviors[].behavior_title yes string
behaviors[].state yes string Values: active, archived
behaviors[].completed yes integer minimum: 0
behaviors[].not_completed yes integer minimum: 0
behaviors[].unresolved yes integer Includes Needs decision. Excluded from adherence.; minimum: 0
behaviors[].needs_decision yes integer Unresolved Occurrences before today.; minimum: 0
behaviors[].adherence_rate yes number or null Adherence is Completed divided by Completed plus Not Completed. Unresolved Occurrences, including Needs decision, are excluded. It is null when nothing is resolved.; minimum: 0; maximum: 1
behaviors[].opportunity_completed_count yes integer Completed opportunity Occurrences, the ones added to a day. Counted apart: the other counts and adherence_rate cover scheduled Occurrences only (contract 1.6.0).; minimum: 0

Example call

Synthetic contract fixture. Replace identifiers and dates with records returned for your account. This is the SDK tools/call payload, not a complete HTTP request.

{
  "name": "get_adherence_summary",
  "arguments": {
    "start_local_date": "2025-10-19",
    "end_local_date": "2026-10-18"
  }
}

Example result

Synthetic success data from a contract fixture, shown as structuredContent. Input and output examples validate independently; they are not a recorded transaction.

{
  "start_local_date": "2026-10-01",
  "end_local_date": "2026-10-18",
  "timezone": "America/New_York",
  "adherence_definition": "Adherence is Completed divided by Completed plus Not Completed. Unresolved Occurrences, including Needs decision, are excluded. It is null when nothing is resolved.",
  "overall": {
    "completed": 8,
    "not_completed": 2,
    "unresolved": 3,
    "needs_decision": 1,
    "adherence_rate": 0.8,
    "opportunity_completed_count": 0
  },
  "behaviors": [
    {
      "behavior_id": "00000001-1111-4111-8111-000000000001",
      "behavior_title": "Morning walk",
      "state": "active",
      "completed": 8,
      "not_completed": 2,
      "unresolved": 3,
      "needs_decision": 1,
      "adherence_rate": 0.8,
      "opportunity_completed_count": 0
    },
    {
      "behavior_id": "00000002-1111-4111-8111-000000000002",
      "behavior_title": "Vitamin D",
      "state": "archived",
      "completed": 0,
      "not_completed": 0,
      "unresolved": 2,
      "needs_decision": 2,
      "adherence_rate": null,
      "opportunity_completed_count": 0
    }
  ]
}

Errors

  • invalid_input: The input does not match the tool’s schema or rules. field_errors names each problem.
  • authentication_required: The access token is missing, expired, revoked, or issued for another resource. Reconnect Cadence.
  • rate_limited: Too many requests for this connection. Retry after retry_after_seconds.
  • service_unavailable: Cadence integrations are temporarily unavailable.
  • internal_error: Cadence could not complete the request. Nothing is assumed to have changed; retry once with the same idempotency_key.
  • limit_exceeded: The request asks for more than a contract limit allows, such as too long a date range or too large a result. Narrow the request.

Output size limits can also return limit_exceeded. See error handling, limits, and safe retries.