Functions — github.com/ReAPI-com/mcp-openapi

hub / github.com/ReAPI-com/mcp-openapi / functions

Functions78 in github.com/ReAPI-com/mcp-openapi

⨍ Functions 78 ◇ Types & classes 40

↓ 15 callersMethodloadSpec

* Load a single specification by ID

src/core/interfaces/ISpecService.ts:134

↓ 14 callersMethoddebug

(message: string, context?: LogContext)

src/core/Logger.ts:6

↓ 14 callersMethoderror

(message: string, context?: LogContext)

src/core/Logger.ts:12

↓ 11 callersMethodinfo

(message: string, context?: LogContext)

src/core/Logger.ts:8

↓ 10 callersMethodprocess

* Process an OpenAPI document by dereferencing and transforming it * @param spec The OpenAPI document to process * @returns A processed version

src/core/interfaces/ISpecProcessor.ts:25

↓ 7 callersMethodinitialize

* Initialize the spec explorer

src/core/interfaces/ISpecService.ts:144

↓ 6 callersMethodfindOperationByPathAndMethod

* Find an operation by path and method when operationId is not known

src/core/interfaces/ISpecService.ts:175

↓ 6 callersMethodwarn

(message: string, context?: LogContext)

src/core/Logger.ts:10

↓ 5 callersFunctioncreateTestConfig

(basePath: string)

src/core/__tests__/SpecPersister.test.ts:17

↓ 5 callersMethodfindOperationById

* Find an operation by its ID within a specification

src/core/interfaces/ISpecService.ts:167

↓ 5 callersMethodfindSchemaByName

* Find a schema by name within a specification

src/core/interfaces/ISpecService.ts:159

↓ 5 callersMethodloadSpecCatalog

* Load the catalog of specifications

src/core/interfaces/ISpecService.ts:124

↓ 5 callersMethodsaveSpec

* Persist a single specification

src/core/interfaces/ISpecService.ts:129

↓ 5 callersMethodsearchOperations

* Search for operations across specifications

src/core/interfaces/ISpecService.ts:184

↓ 4 callersMethodensureDirectory

(dir: string)

src/core/SpecService.ts:80

↓ 4 callersMethodlog

(level: string, messageOrContext: string | LogContext, contextOrMessage?: LogContext | string)

src/core/Logger.ts:24

↓ 4 callersMethodprocessSchema

* Processes a schema object, merging allOf if present * @param schema The schema to process * @returns The processed schema

src/core/SpecProcessor.ts:121

↓ 4 callersMethodsearchSchemas

* Search for schemas across specifications

src/core/interfaces/ISpecService.ts:192

↓ 3 callersMethodset

(key: K, value: V)

src/core/Cache.ts:53

↓ 2 callersMethodclear

()

src/core/Cache.ts:79

↓ 2 callersMethodcreateServer

()

src/McpService.ts:34

↓ 2 callersMethodensureDirectories

()

src/core/SpecService.ts:92

↓ 2 callersMethodisSchemaObject

* Type guard to check if a schema is a SchemaObject (not a ReferenceObject)

src/core/SpecProcessor.ts:211

↓ 2 callersMethodmergeSchemas

* Merges multiple schemas into one * @param schemas The schemas to merge * @returns The merged schema

src/core/SpecProcessor.ts:165

↓ 2 callersMethodresetState

()

src/core/SpecService.ts:101

↓ 2 callersMethodscan

* Scan a folder for OpenAPI specs and yield them one at a time * This allows for memory-efficient processing of large specs * @param folderPath

src/core/interfaces/ISpecScanner.ts:52

↓ 2 callersMethodscanAndSave

* Scan a directory and persist found specifications

src/core/interfaces/ISpecService.ts:114

↓ 1 callersMethodcleanup

()

src/core/Cache.ts:44

↓ 1 callersFunctioncreateTestConfig

(basePath: string)

src/core/__tests__/SpecExplorer.test.ts:14

↓ 1 callersMethodextractSpecId

* Extracts the spec ID from the spec object * @param spec - The parsed spec object * @param defaultId - Default ID to use if none is found in th

src/core/SpecScanner.ts:228

↓ 1 callersMethodget

(key: K)

src/core/Cache.ts:66

↓ 1 callersMethodgetApiCatalog

* List all specifications in the catalog

src/core/interfaces/ISpecService.ts:154

↓ 1 callersMethodgetFileType

* Determines the file type based on the file extension * @param filePath - Path to the file * @returns The detected file type

src/core/SpecScanner.ts:127

↓ 1 callersMethodinitialize

()

src/core/SpecService.ts:129

↓ 1 callersMethodinitializeExplorer

()

src/McpService.ts:23

↓ 1 callersMethodisValidSpecObject

* Validates that the parsed object has the basic structure of an OpenAPI spec * @param spec - The parsed spec object * @returns true if the spec

src/core/SpecScanner.ts:212

↓ 1 callersMethodloadExistingCatalog

()

src/core/SpecService.ts:108

↓ 1 callersMethodloadSpec

(specId: string)

src/core/SpecService.ts:286

↓ 1 callersMethodloadSpecCatalog

()

src/core/SpecService.ts:273

↓ 1 callersFunctionmain

()

src/cli.ts:46

↓ 1 callersMethodmergeAllOfSchemas

* Recursively traverses the OpenAPI spec and merges any allOf schemas found * @param spec The OpenAPI specification to process * @returns The pr

src/core/SpecProcessor.ts:36

↓ 1 callersMethodparseSpec

* Parses the spec content based on the file type and converts Swagger 2.0 to OpenAPI 3.0 if needed * @param content - Raw file content * @param

src/core/SpecScanner.ts:144

↓ 1 callersMethodprocessFile

* Processes a single OpenAPI specification file * @param folderPath - Path to the directory containing the file * @param filename - Name of the

src/core/SpecScanner.ts:82

↓ 1 callersMethodprocessPathItem

* Processes a path item object, handling all nested schemas * @param pathItem The path item to process

src/core/SpecProcessor.ts:63

↓ 1 callersMethodrefresh

* Refresh the spec explorer

src/core/interfaces/ISpecService.ts:149

↓ 1 callersMethodsaveSpec

(spec: OpenAPIV3.Document, specId: string)

src/core/SpecService.ts:246

↓ 1 callersMethodsaveSpecCatalog

(catalog: SpecCatalogEntry[])

src/core/SpecService.ts:265

↓ 1 callersMethodsaveSpecCatalog

* Persist the catalog of specifications

src/core/interfaces/ISpecService.ts:119

↓ 1 callersMethodscanAndSave

(folderPath: string)

src/core/SpecService.ts:150

↓ 1 callersMethodsetUpTools

(server: McpServer)

src/McpService.ts:47

↓ 1 callersMethodstartCleanupTimer

()

src/core/Cache.ts:28

↓ 1 callersMethodstopCleanupTimer

()

src/core/Cache.ts:37

Methodconstructor

( private readonly specExplorer: ISpecExplorer, logger?: Logger )

src/McpService.ts:12

Methodconstructor

( message: string, public readonly code: | "INIT_ERROR" | "PERSIST_ERROR" | "LOAD_ER

src/core/SpecService.ts:25

Methodconstructor

( private readonly scanner: ISpecScanner, config: SpecServiceConfig, logger?: Logger )

src/core/SpecService.ts:49

Methodconstructor

(options: CacheOptions = {})

src/core/Cache.ts:19

Methodconstructor

()

src/core/Logger.ts:19

Methodconstructor

( message: string, public readonly filename: string, public readonly cause?: Error )

src/core/SpecScanner.ts:17

Methodconstructor

(private readonly specProcessor: ISpecProcessor)

src/core/SpecScanner.ts:33

Methoddebug

(messageOrContext: string | LogContext, contextOrMessage?: LogContext | string)

src/core/Logger.ts:46

(messageOrContext: string | LogContext, contextOrMessage?: LogContext | string)

src/core/Logger.ts:58

MethodfindOperationById

( specId: string, operationId: string )

src/core/SpecService.ts:439

MethodfindOperationByPathAndMethod

( specId: string, path: string, method: string )

src/core/SpecService.ts:465

MethodfindSchemaByName

( specId: string, schemaName: string )

src/core/SpecService.ts:417

MethodgetApiCatalog

()

src/core/SpecService.ts:242

Methodinfo

(messageOrContext: string | LogContext, contextOrMessage?: LogContext | string)

src/core/Logger.ts:50

Methodprocess

(spec: OpenAPIV3.Document)

src/core/SpecProcessor.ts:21

Methodrefresh

()

src/core/SpecService.ts:321

Methodscan

* Scans a directory for OpenAPI specification files and yields processed results * @param folderPath - Path to the directory containing OpenAPI spe

src/core/SpecScanner.ts:40

MethodsearchOperations

( query: string, specId?: string )

src/core/SpecService.ts:328

MethodsearchSchemas

( query: string, specId?: string )

src/core/SpecService.ts:383

MethodserializeOperation

* Serialize an operation result to string

src/core/interfaces/ISpecService.ts:202

MethodserializeSchema

* Serialize a schema result to string

src/core/interfaces/ISpecService.ts:207

MethodsetUpPrompts

(server: McpServer)

src/McpService.ts:250

MethodsetUpResources

(server: McpServer)

src/McpService.ts:332

Methodsync

* Synchronize specifications from sources to target directory * @param config Configuration for the sync operation * @returns Array of results f

src/core/interfaces/ISyncManager.ts:53

Methodwarn

(messageOrContext: string | LogContext, contextOrMessage?: LogContext | string)

src/core/Logger.ts:54