naftiko: 1.0.0-alpha2
info:
  label: FactSet IRN Custom Symbols API — Symbols
  description: 'FactSet IRN Custom Symbols API — Symbols. 14 operations. Lead operation: Factset Get List of All Custom Symbols
    in Your Group Along With Some of Their Standard Field and Custom Fields Data. Self-contained Naftiko capability covering
    one Factset business surface.'
  tags:
  - Factset
  - Symbols
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: irn-custom-symbols-symbols
    baseUri: https://api.factset.com/research/irn
    description: FactSet IRN Custom Symbols API — Symbols business capability. Self-contained, no shared references.
    resources:
    - name: v1-custom-symbols
      path: /v1/custom-symbols
      operations:
      - name: getcustomsymbols
        method: GET
        description: Factset Get List of All Custom Symbols in Your Group Along With Some of Their Standard Field and Custom
          Fields Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: typeName
          in: query
          type: string
          description: filter custom symbols based on custom symbol type
        - name: query
          in: query
          type: string
          description: filter custom symbols based on custom symbol code or name
        - name: includeCustomFieldValues
          in: query
          type: boolean
          description: Whether or not to include customFieldValues
        - name: excludeLinkedCustomSymbol
          in: query
          type: boolean
          description: Whether or not to exclude linked custom symbol
        - name: includeEvent
          in: query
          type: boolean
          description: Whether or not to include event
      - name: createcustomsymbol
        method: POST
        description: Factset Create a Custom Symbol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-custom-symbols-standard-symbol-metadata
      path: /v1/custom-symbols/standard-symbol-metadata
      operations:
      - name: createstandardsymbolmetadata
        method: POST
        description: Factset Create Standard Symbol Metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-custom-symbols-standard-symbol-metadata-standardSymbolId
      path: /v1/custom-symbols/standard-symbol-metadata/{standardSymbolId}
      operations:
      - name: patchstandardsymbol
        method: PATCH
        description: Factset Edit a Standard Symbols Standard Field and Custom Field Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: standardSymbolId
          in: path
          type: string
          description: standardSymbolId to update associated standard symbol
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-custom-symbols-standard-symbol-metadata-standardSymbol
      path: /v1/custom-symbols/standard-symbol-metadata/{standardSymbol}
      operations:
      - name: getstandardsymbolmetadataguid
        method: GET
        description: Factset Get All Custom Field and Standard Field Details on a Specific Standard Symbol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: standardSymbol
          in: path
          type: string
          description: Standard symbol to get associated customSymbolId
          required: true
    - name: v1-custom-symbols-customSymbolId
      path: /v1/custom-symbols/{customSymbolId}
      operations:
      - name: getcustomsymbol
        method: GET
        description: Factset Get All Custom Field and Standard Field Details on a Specific Custom Symbol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolId
          in: path
          type: string
          description: customSymbolId to get associated custom symbol
          required: true
        - name: includeEvent
          in: query
          type: boolean
          description: Whether or not to include event
      - name: patchcustomsymbol
        method: PATCH
        description: Factset Edit a Custom Symbols Standard Field and Custom Field Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolId
          in: path
          type: string
          description: customSymbolId to update associated custom symbol
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletecustomsymbol
        method: DELETE
        description: Factset Delete a Custom Symbol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolId
          in: path
          type: string
          description: customSymbolId to delete associated custom symbol
          required: true
    - name: v1-custom-symbols-customSymbolId-link-standard-symbol
      path: /v1/custom-symbols/{customSymbolId}/link-standard-symbol
      operations:
      - name: linkcustomsymboltostandardsymbol
        method: POST
        description: Factset Link Custom Symbol to Standard Symbol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolId
          in: path
          type: string
          description: customSymbolId associated with custom symbol
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-custom-symbols-customSymbolId-records
      path: /v1/custom-symbols/{customSymbolId}/records
      operations:
      - name: getcustomsymbolrecords
        method: GET
        description: Factset Get All Notes and Meetings Where a Specific Customsymbol Was Tagged as Primary or Related Identifier
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolId
          in: path
          type: string
          description: CustomSymbolId to get associated records
          required: true
    - name: v1-symbol-relationships-symbolId-relationships
      path: /v1/symbol-relationships/{symbolId}/relationships
      operations:
      - name: getsymbolrelationships
        method: GET
        description: Factset Returns a List of a Symbols Relationships
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: symbolId
          in: path
          type: string
          description: symbolId to get associated records
          required: true
    - name: v1-symbol-relationships-symbolRelationshipId
      path: /v1/symbol-relationships/{symbolRelationshipId}
      operations:
      - name: getsymbolrelationship
        method: GET
        description: Factset Get Details on a Specific Symbol Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: symbolRelationshipId
          in: path
          type: string
          description: symbolRelationshipId to get associated record
          required: true
      - name: deletesymbolrelationship
        method: DELETE
        description: Factset Delete a Symbol Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: symbolRelationshipId
          in: path
          type: string
          description: symbolRelationshipId to delete associated record
          required: true
    - name: v1-symbol-relationships-symbol
      path: /v1/symbol-relationships/{symbol}
      operations:
      - name: editandaddsymbolrelationship
        method: PUT
        description: Factset Edit a Symbol Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: symbol
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: irn-custom-symbols-symbols-rest
    port: 8080
    description: REST adapter for FactSet IRN Custom Symbols API — Symbols. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/custom-symbols
      name: v1-custom-symbols
      description: REST surface for v1-custom-symbols.
      operations:
      - method: GET
        name: getcustomsymbols
        description: Factset Get List of All Custom Symbols in Your Group Along With Some of Their Standard Field and Custom
          Fields Data
        call: irn-custom-symbols-symbols.getcustomsymbols
        with:
          typeName: rest.typeName
          query: rest.query
          includeCustomFieldValues: rest.includeCustomFieldValues
          excludeLinkedCustomSymbol: rest.excludeLinkedCustomSymbol
          includeEvent: rest.includeEvent
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcustomsymbol
        description: Factset Create a Custom Symbol
        call: irn-custom-symbols-symbols.createcustomsymbol
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/standard-symbol-metadata
      name: v1-custom-symbols-standard-symbol-metadata
      description: REST surface for v1-custom-symbols-standard-symbol-metadata.
      operations:
      - method: POST
        name: createstandardsymbolmetadata
        description: Factset Create Standard Symbol Metadata
        call: irn-custom-symbols-symbols.createstandardsymbolmetadata
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/standard-symbol-metadata/{standardsymbolid}
      name: v1-custom-symbols-standard-symbol-metadata-standardsymbolid
      description: REST surface for v1-custom-symbols-standard-symbol-metadata-standardSymbolId.
      operations:
      - method: PATCH
        name: patchstandardsymbol
        description: Factset Edit a Standard Symbols Standard Field and Custom Field Data
        call: irn-custom-symbols-symbols.patchstandardsymbol
        with:
          standardSymbolId: rest.standardSymbolId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/standard-symbol-metadata/{standardsymbol}
      name: v1-custom-symbols-standard-symbol-metadata-standardsymbol
      description: REST surface for v1-custom-symbols-standard-symbol-metadata-standardSymbol.
      operations:
      - method: GET
        name: getstandardsymbolmetadataguid
        description: Factset Get All Custom Field and Standard Field Details on a Specific Standard Symbol
        call: irn-custom-symbols-symbols.getstandardsymbolmetadataguid
        with:
          standardSymbol: rest.standardSymbol
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/{customsymbolid}
      name: v1-custom-symbols-customsymbolid
      description: REST surface for v1-custom-symbols-customSymbolId.
      operations:
      - method: GET
        name: getcustomsymbol
        description: Factset Get All Custom Field and Standard Field Details on a Specific Custom Symbol
        call: irn-custom-symbols-symbols.getcustomsymbol
        with:
          customSymbolId: rest.customSymbolId
          includeEvent: rest.includeEvent
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchcustomsymbol
        description: Factset Edit a Custom Symbols Standard Field and Custom Field Data
        call: irn-custom-symbols-symbols.patchcustomsymbol
        with:
          customSymbolId: rest.customSymbolId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecustomsymbol
        description: Factset Delete a Custom Symbol
        call: irn-custom-symbols-symbols.deletecustomsymbol
        with:
          customSymbolId: rest.customSymbolId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/{customsymbolid}/link-standard-symbol
      name: v1-custom-symbols-customsymbolid-link-standard-symbol
      description: REST surface for v1-custom-symbols-customSymbolId-link-standard-symbol.
      operations:
      - method: POST
        name: linkcustomsymboltostandardsymbol
        description: Factset Link Custom Symbol to Standard Symbol
        call: irn-custom-symbols-symbols.linkcustomsymboltostandardsymbol
        with:
          customSymbolId: rest.customSymbolId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbols/{customsymbolid}/records
      name: v1-custom-symbols-customsymbolid-records
      description: REST surface for v1-custom-symbols-customSymbolId-records.
      operations:
      - method: GET
        name: getcustomsymbolrecords
        description: Factset Get All Notes and Meetings Where a Specific Customsymbol Was Tagged as Primary or Related Identifier
        call: irn-custom-symbols-symbols.getcustomsymbolrecords
        with:
          customSymbolId: rest.customSymbolId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/symbol-relationships/{symbolid}/relationships
      name: v1-symbol-relationships-symbolid-relationships
      description: REST surface for v1-symbol-relationships-symbolId-relationships.
      operations:
      - method: GET
        name: getsymbolrelationships
        description: Factset Returns a List of a Symbols Relationships
        call: irn-custom-symbols-symbols.getsymbolrelationships
        with:
          symbolId: rest.symbolId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/symbol-relationships/{symbolrelationshipid}
      name: v1-symbol-relationships-symbolrelationshipid
      description: REST surface for v1-symbol-relationships-symbolRelationshipId.
      operations:
      - method: GET
        name: getsymbolrelationship
        description: Factset Get Details on a Specific Symbol Relationship
        call: irn-custom-symbols-symbols.getsymbolrelationship
        with:
          symbolRelationshipId: rest.symbolRelationshipId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesymbolrelationship
        description: Factset Delete a Symbol Relationship
        call: irn-custom-symbols-symbols.deletesymbolrelationship
        with:
          symbolRelationshipId: rest.symbolRelationshipId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/symbol-relationships/{symbol}
      name: v1-symbol-relationships-symbol
      description: REST surface for v1-symbol-relationships-symbol.
      operations:
      - method: PUT
        name: editandaddsymbolrelationship
        description: Factset Edit a Symbol Relationship
        call: irn-custom-symbols-symbols.editandaddsymbolrelationship
        with:
          symbol: rest.symbol
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: irn-custom-symbols-symbols-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet IRN Custom Symbols API — Symbols. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: factset-get-list-all-custom
      description: Factset Get List of All Custom Symbols in Your Group Along With Some of Their Standard Field and Custom
        Fields Data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbols.getcustomsymbols
      with:
        typeName: tools.typeName
        query: tools.query
        includeCustomFieldValues: tools.includeCustomFieldValues
        excludeLinkedCustomSymbol: tools.excludeLinkedCustomSymbol
        includeEvent: tools.includeEvent
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-custom-symbol
      description: Factset Create a Custom Symbol
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-custom-symbols-symbols.createcustomsymbol
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-standard-symbol-metadata
      description: Factset Create Standard Symbol Metadata
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-custom-symbols-symbols.createstandardsymbolmetadata
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-standard-symbols-standard
      description: Factset Edit a Standard Symbols Standard Field and Custom Field Data
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbols.patchstandardsymbol
      with:
        standardSymbolId: tools.standardSymbolId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-all-custom-field
      description: Factset Get All Custom Field and Standard Field Details on a Specific Standard Symbol
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbols.getstandardsymbolmetadataguid
      with:
        standardSymbol: tools.standardSymbol
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-all-custom-field-2
      description: Factset Get All Custom Field and Standard Field Details on a Specific Custom Symbol
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbols.getcustomsymbol
      with:
        customSymbolId: tools.customSymbolId
        includeEvent: tools.includeEvent
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-custom-symbols-standard
      description: Factset Edit a Custom Symbols Standard Field and Custom Field Data
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbols.patchcustomsymbol
      with:
        customSymbolId: tools.customSymbolId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-delete-custom-symbol
      description: Factset Delete a Custom Symbol
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: irn-custom-symbols-symbols.deletecustomsymbol
      with:
        customSymbolId: tools.customSymbolId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-link-custom-symbol-standard
      description: Factset Link Custom Symbol to Standard Symbol
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-custom-symbols-symbols.linkcustomsymboltostandardsymbol
      with:
        customSymbolId: tools.customSymbolId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-all-notes-and
      description: Factset Get All Notes and Meetings Where a Specific Customsymbol Was Tagged as Primary or Related Identifier
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbols.getcustomsymbolrecords
      with:
        customSymbolId: tools.customSymbolId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-list-symbols-relationships
      description: Factset Returns a List of a Symbols Relationships
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbols.getsymbolrelationships
      with:
        symbolId: tools.symbolId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-details-specific-symbol
      description: Factset Get Details on a Specific Symbol Relationship
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbols.getsymbolrelationship
      with:
        symbolRelationshipId: tools.symbolRelationshipId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-delete-symbol-relationship
      description: Factset Delete a Symbol Relationship
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: irn-custom-symbols-symbols.deletesymbolrelationship
      with:
        symbolRelationshipId: tools.symbolRelationshipId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-symbol-relationship
      description: Factset Edit a Symbol Relationship
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbols.editandaddsymbolrelationship
      with:
        symbol: tools.symbol
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.