aps_submittals_docs

Instructions

Implementation Reference

• src/index.ts:985-993 (registration)

  Tool registration for aps_submittals_docs in the TOOLS array. Defines the tool name, description, and empty input schema. No parameters needed – it returns static documentation text.

  // 25 ── aps_submittals_docs
  {
    name: "aps_submittals_docs",
    description:
      "Return ACC Submittals API quick‑reference documentation: " +
      "endpoints, query parameters, statuses, custom numbering, typical workflow, and key concepts. " +
      "Call this before your first Submittals interaction or when unsure about Submittals API usage.",
    inputSchema: { type: "object" as const, properties: {} },
  },

• src/index.ts:1572-1575 (handler)

  Handler for aps_submittals_docs inside handleTool(). Simply returns the SUBMITTALS_DOCS constant (an imported string) as the tool response.

  // ── aps_submittals_docs ─────────────────────────────────────
  if (name === "aps_submittals_docs") {
    return ok(SUBMITTALS_DOCS);
  }

• src/aps-submittals-helpers.ts:260-359 (helper)

  The SUBMITTALS_DOCS constant exported from aps-submittals-helpers.ts. A template literal string containing the full ACC Submittals API quick-reference documentation with endpoints, query parameters, statuses, priorities, custom numbering, typical workflow, and links to official docs.

  export const SUBMITTALS_DOCS = `# ACC Submittals API – Quick Reference
  
  ## Overview
  The ACC Submittals API lets you read and create submittal items, packages, spec sections,
  attachments, and responses for Autodesk Construction Cloud (ACC Build) projects.
  
  ## Project ID Format
  - The Submittals API uses **UUID** project IDs (e.g. \`abc12345-6789-…\`).
  - If you have a Data Management project ID with \`b.\` prefix, the prefix is stripped automatically.
  - Account ID is also a UUID (hub ID without \`b.\` prefix).
  
  ## Authentication
  - **2‑legged OAuth** with scopes: \`data:read\` (read), \`data:write\` (create/update).
  - Uses the same token as the Data Management tools.
  
  ## API Base Path
  \`https://developer.api.autodesk.com/construction/submittals/v2/projects/{projectId}/…\`
  
  ## Available Endpoints
  
  ### Read Endpoints
  | Action | Method | Path |
  |--------|--------|------|
  | List submittal items | GET | items |
  | Get submittal item | GET | items/{itemId} |
  | List packages | GET | packages |
  | Get package | GET | packages/{packageId} |
  | List spec sections | GET | specs |
  | Get item type | GET | item-types/{id} |
  | List item types | GET | item-types |
  | List responses | GET | responses |
  | Get response | GET | responses/{id} |
  | Item attachments | GET | items/{itemId}/attachments |
  | Project metadata | GET | metadata |
  | Manager settings | GET | settings/mappings |
  | Current user perms | GET | users/me |
  | Next custom number | GET | items:next-custom-identifier |
  
  ### Write Endpoints
  | Action | Method | Path |
  |--------|--------|------|
  | Create submittal item | POST | items |
  | Create spec section | POST | specs |
  | Validate custom number | POST | items:validate-custom-identifier |
  
  ## Common Query Parameters (GET items)
  - \`limit\` – items per page (default 20, max 200)
  - \`offset\` – pagination offset
  - \`filter[statusId]\` – filter by status: 1=Required, 2=Open, 3=Closed, 4=Void, 5=Empty, 6=Draft
  - \`filter[packageId]\` – filter by package ID
  - \`filter[reviewResponseId]\` – filter by review response ID
  - \`filter[specId]\` – filter by spec section ID
  - \`sort\` – sort by field (e.g. \`title\`, \`createdAt\`)
  
  ## Submittal Item Statuses
  | ID | Status |
  |----|--------|
  | 1 | Required |
  | 2 | Open |
  | 3 | Closed |
  | 4 | Void |
  | 5 | Empty |
  | 6 | Draft |
  
  ## Submittal Item Priorities
  | ID | Priority |
  |----|----------|
  | 1 | Low |
  | 2 | Normal |
  | 3 | High |
  
  ## Custom Numbering
  - **Global format**: items get a global sequential number.
  - **Spec section format**: items numbered as \`<specId>-<sequence>\` (e.g. \`033100-01\`).
  - \`customIdentifier\` – the sequential number portion.
  - \`customIdentifierHumanReadable\` – the full display number.
  
  ## Typical Workflow
  \`\`\`
  1. aps_list_hubs / aps_list_projects          → get project ID
  2. aps_list_submittal_specs   project_id       → see spec sections
  3. aps_list_submittal_packages project_id      → see packages
  4. aps_list_submittal_items   project_id       → browse items (with filters)
  5. aps_get_submittal_item     project_id + id  → item details
  6. aps_get_submittal_item_attachments          → view attachments
  \`\`\`
  
  ## Key Concepts
  - **Submittal Item**: A document (shop drawing, product data, sample, etc.) that requires review.
  - **Package**: Groups related submittal items for batch submission.
  - **Spec Section**: A specification division (e.g. "033100 – Structural Concrete").
  - **Response**: The review outcome (e.g. Approved, Revise and Resubmit).
  - **Review Step / Task**: Multi‑step review workflow with assigned reviewers.
  
  ## Full Documentation
  - Field Guide: https://aps.autodesk.com/en/docs/acc/v1/overview/field-guide/submittals/
  - API Reference: https://aps.autodesk.com/en/docs/acc/v1/reference/http/submittals-items-GET/
  - Create Item Tutorial: https://aps.autodesk.com/en/docs/acc/v1/tutorials/submittals/create-submittal-item/
  - Data Schema: https://developer.api.autodesk.com/data-connector/v1/doc/schema?name=submittalsacc&format=html
  `;

• src/index.ts:992-992 (schema)

  Input schema for aps_submittals_docs – an empty object schema, as this tool takes no parameters.

  inputSchema: { type: "object" as const, properties: {} },