doc-weaver init and cross wiki-lib links fixes
Some checks reported errors
continuous-integration/drone/push Build was killed
Some checks reported errors
continuous-integration/drone/push Build was killed
This commit is contained in:
23
doc-weaver/mcp/modules/cli.commands.json
Normal file
23
doc-weaver/mcp/modules/cli.commands.json
Normal file
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"module": "cli.commands",
|
||||
"content": {
|
||||
"path": "cli.commands",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"buildCommand": {
|
||||
"name": "buildCommand",
|
||||
"kind": "function",
|
||||
"path": "cli.commands.buildCommand",
|
||||
"signature": "buildCommand(): Command",
|
||||
"docstring": ""
|
||||
},
|
||||
"serveCommand": {
|
||||
"name": "serveCommand",
|
||||
"kind": "function",
|
||||
"path": "cli.commands.serveCommand",
|
||||
"signature": "serveCommand(): Command",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
16
doc-weaver/mcp/modules/cli.json
Normal file
16
doc-weaver/mcp/modules/cli.json
Normal file
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"module": "cli",
|
||||
"content": {
|
||||
"path": "cli",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"main": {
|
||||
"name": "main",
|
||||
"kind": "function",
|
||||
"path": "cli.main",
|
||||
"signature": "main(): void",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
23
doc-weaver/mcp/modules/cli.mcp-utils.json
Normal file
23
doc-weaver/mcp/modules/cli.mcp-utils.json
Normal file
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"module": "cli.mcp-utils",
|
||||
"content": {
|
||||
"path": "cli.mcp-utils",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"generateMcpResources": {
|
||||
"name": "generateMcpResources",
|
||||
"kind": "function",
|
||||
"path": "cli.mcp-utils.generateMcpResources",
|
||||
"signature": "generateMcpResources(typedocJson: any, projectName: undefined | string, outDir: string): Promise<void>",
|
||||
"docstring": ""
|
||||
},
|
||||
"serveMcp": {
|
||||
"name": "serveMcp",
|
||||
"kind": "function",
|
||||
"path": "cli.mcp-utils.serveMcp",
|
||||
"signature": "serveMcp(module: string, mcpRoot: string): Promise<void>",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
135
doc-weaver/mcp/modules/index.json
Normal file
135
doc-weaver/mcp/modules/index.json
Normal file
@@ -0,0 +1,135 @@
|
||||
{
|
||||
"module": "index",
|
||||
"content": {
|
||||
"path": "index",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"collectModules": {
|
||||
"name": "collectModules",
|
||||
"kind": "unknown",
|
||||
"path": "index.collectModules",
|
||||
"signature": "collectModules",
|
||||
"docstring": ""
|
||||
},
|
||||
"defaultTsconfigFor": {
|
||||
"name": "defaultTsconfigFor",
|
||||
"kind": "unknown",
|
||||
"path": "index.defaultTsconfigFor",
|
||||
"signature": "defaultTsconfigFor",
|
||||
"docstring": ""
|
||||
},
|
||||
"DocKind": {
|
||||
"name": "DocKind",
|
||||
"kind": "unknown",
|
||||
"path": "index.DocKind",
|
||||
"signature": "DocKind",
|
||||
"docstring": ""
|
||||
},
|
||||
"DocModule": {
|
||||
"name": "DocModule",
|
||||
"kind": "unknown",
|
||||
"path": "index.DocModule",
|
||||
"signature": "DocModule",
|
||||
"docstring": ""
|
||||
},
|
||||
"DocObject": {
|
||||
"name": "DocObject",
|
||||
"kind": "unknown",
|
||||
"path": "index.DocObject",
|
||||
"signature": "DocObject",
|
||||
"docstring": ""
|
||||
},
|
||||
"DocProject": {
|
||||
"name": "DocProject",
|
||||
"kind": "unknown",
|
||||
"path": "index.DocProject",
|
||||
"signature": "DocProject",
|
||||
"docstring": ""
|
||||
},
|
||||
"generateHumanDocs": {
|
||||
"name": "generateHumanDocs",
|
||||
"kind": "unknown",
|
||||
"path": "index.generateHumanDocs",
|
||||
"signature": "generateHumanDocs",
|
||||
"docstring": ""
|
||||
},
|
||||
"generateMcpResources": {
|
||||
"name": "generateMcpResources",
|
||||
"kind": "unknown",
|
||||
"path": "index.generateMcpResources",
|
||||
"signature": "generateMcpResources",
|
||||
"docstring": ""
|
||||
},
|
||||
"HumanDocsOptions": {
|
||||
"name": "HumanDocsOptions",
|
||||
"kind": "unknown",
|
||||
"path": "index.HumanDocsOptions",
|
||||
"signature": "HumanDocsOptions",
|
||||
"docstring": ""
|
||||
},
|
||||
"main": {
|
||||
"name": "main",
|
||||
"kind": "unknown",
|
||||
"path": "index.main",
|
||||
"signature": "main",
|
||||
"docstring": "# doc-weaver\n\nPublic library surface for doc-weaver, the TypeScript counterpart to\n`doc-forge`. It compiles TypeDoc reflection (built from TypeScript + JSDoc)\ninto two renderers:\n\n- a human-facing TypeDoc site (the MkDocs parallel), and\n- a machine-facing MCP JSON bundle (`index.json`, `nav.json`, `modules/`)\n whose shape is byte-compatible with `doc-forge`.\n\nProgrammatic usage:\n\n import { runTypeDocJson, TypeDocJsonToMCP } from 'doc-weaver';\n const json = await runTypeDocJson({ entryPoints: ['src/index.ts'] });\n const bundle = new TypeDocJsonToMCP(json, 'my-app').transform();"
|
||||
},
|
||||
"McpBundle": {
|
||||
"name": "McpBundle",
|
||||
"kind": "unknown",
|
||||
"path": "index.McpBundle",
|
||||
"signature": "McpBundle",
|
||||
"docstring": ""
|
||||
},
|
||||
"MCPServer": {
|
||||
"name": "MCPServer",
|
||||
"kind": "unknown",
|
||||
"path": "index.MCPServer",
|
||||
"signature": "MCPServer",
|
||||
"docstring": ""
|
||||
},
|
||||
"RefKind": {
|
||||
"name": "RefKind",
|
||||
"kind": "unknown",
|
||||
"path": "index.RefKind",
|
||||
"signature": "RefKind",
|
||||
"docstring": ""
|
||||
},
|
||||
"resolveModulePath": {
|
||||
"name": "resolveModulePath",
|
||||
"kind": "unknown",
|
||||
"path": "index.resolveModulePath",
|
||||
"signature": "resolveModulePath",
|
||||
"docstring": ""
|
||||
},
|
||||
"runTypeDocJson": {
|
||||
"name": "runTypeDocJson",
|
||||
"kind": "unknown",
|
||||
"path": "index.runTypeDocJson",
|
||||
"signature": "runTypeDocJson",
|
||||
"docstring": ""
|
||||
},
|
||||
"serveMcp": {
|
||||
"name": "serveMcp",
|
||||
"kind": "unknown",
|
||||
"path": "index.serveMcp",
|
||||
"signature": "serveMcp",
|
||||
"docstring": ""
|
||||
},
|
||||
"TypeDocJsonToMCP": {
|
||||
"name": "TypeDocJsonToMCP",
|
||||
"kind": "unknown",
|
||||
"path": "index.TypeDocJsonToMCP",
|
||||
"signature": "TypeDocJsonToMCP",
|
||||
"docstring": ""
|
||||
},
|
||||
"TypeDocOptions": {
|
||||
"name": "TypeDocOptions",
|
||||
"kind": "unknown",
|
||||
"path": "index.TypeDocOptions",
|
||||
"signature": "TypeDocOptions",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
74
doc-weaver/mcp/modules/loaders.typedoc-loader.json
Normal file
74
doc-weaver/mcp/modules/loaders.typedoc-loader.json
Normal file
@@ -0,0 +1,74 @@
|
||||
{
|
||||
"module": "loaders.typedoc-loader",
|
||||
"content": {
|
||||
"path": "loaders.typedoc-loader",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"TypeDocOptions": {
|
||||
"name": "TypeDocOptions",
|
||||
"kind": "interface",
|
||||
"path": "loaders.typedoc-loader.TypeDocOptions",
|
||||
"signature": "TypeDocOptions",
|
||||
"docstring": "",
|
||||
"members": {
|
||||
"entryPoints": {
|
||||
"name": "entryPoints",
|
||||
"kind": "property",
|
||||
"path": "loaders.typedoc-loader.TypeDocOptions.entryPoints",
|
||||
"signature": "entryPoints: string[]",
|
||||
"docstring": ""
|
||||
},
|
||||
"entryPointStrategy": {
|
||||
"name": "entryPointStrategy",
|
||||
"kind": "property",
|
||||
"path": "loaders.typedoc-loader.TypeDocOptions.entryPointStrategy",
|
||||
"signature": "entryPointStrategy: \"resolve\" | \"expand\" | \"merge\" | \"packages\"",
|
||||
"docstring": "TypeDoc entry-point strategy. Defaults to 'resolve'."
|
||||
},
|
||||
"name": {
|
||||
"name": "name",
|
||||
"kind": "property",
|
||||
"path": "loaders.typedoc-loader.TypeDocOptions.name",
|
||||
"signature": "name: string",
|
||||
"docstring": ""
|
||||
},
|
||||
"plugin": {
|
||||
"name": "plugin",
|
||||
"kind": "property",
|
||||
"path": "loaders.typedoc-loader.TypeDocOptions.plugin",
|
||||
"signature": "plugin: string[]",
|
||||
"docstring": "Optional TypeDoc theme/plugin passthroughs"
|
||||
},
|
||||
"skipErrorChecking": {
|
||||
"name": "skipErrorChecking",
|
||||
"kind": "property",
|
||||
"path": "loaders.typedoc-loader.TypeDocOptions.skipErrorChecking",
|
||||
"signature": "skipErrorChecking: boolean",
|
||||
"docstring": "Skip TypeScript error checking before conversion. Defaults to true so\r\ndocumentation still generates when a project has unrelated type errors."
|
||||
},
|
||||
"tsconfig": {
|
||||
"name": "tsconfig",
|
||||
"kind": "property",
|
||||
"path": "loaders.typedoc-loader.TypeDocOptions.tsconfig",
|
||||
"signature": "tsconfig: string",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultTsconfigFor": {
|
||||
"name": "defaultTsconfigFor",
|
||||
"kind": "function",
|
||||
"path": "loaders.typedoc-loader.defaultTsconfigFor",
|
||||
"signature": "defaultTsconfigFor(root: string): string",
|
||||
"docstring": ""
|
||||
},
|
||||
"runTypeDocJson": {
|
||||
"name": "runTypeDocJson",
|
||||
"kind": "function",
|
||||
"path": "loaders.typedoc-loader.runTypeDocJson",
|
||||
"signature": "runTypeDocJson(opts: TypeDocOptions): Promise<any>",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
120
doc-weaver/mcp/modules/models.json
Normal file
120
doc-weaver/mcp/modules/models.json
Normal file
@@ -0,0 +1,120 @@
|
||||
{
|
||||
"module": "models",
|
||||
"content": {
|
||||
"path": "models",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"DocModule": {
|
||||
"name": "DocModule",
|
||||
"kind": "interface",
|
||||
"path": "models.DocModule",
|
||||
"signature": "DocModule",
|
||||
"docstring": "A single module (typically one source file or package).",
|
||||
"members": {
|
||||
"docstring": {
|
||||
"name": "docstring",
|
||||
"kind": "property",
|
||||
"path": "models.DocModule.docstring",
|
||||
"signature": "docstring: string",
|
||||
"docstring": ""
|
||||
},
|
||||
"objects": {
|
||||
"name": "objects",
|
||||
"kind": "property",
|
||||
"path": "models.DocModule.objects",
|
||||
"signature": "objects: Record<string, DocObject>",
|
||||
"docstring": ""
|
||||
},
|
||||
"path": {
|
||||
"name": "path",
|
||||
"kind": "property",
|
||||
"path": "models.DocModule.path",
|
||||
"signature": "path: string",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
},
|
||||
"DocObject": {
|
||||
"name": "DocObject",
|
||||
"kind": "interface",
|
||||
"path": "models.DocObject",
|
||||
"signature": "DocObject",
|
||||
"docstring": "A documentation object with an optional tree of members.",
|
||||
"members": {
|
||||
"docstring": {
|
||||
"name": "docstring",
|
||||
"kind": "property",
|
||||
"path": "models.DocObject.docstring",
|
||||
"signature": "docstring: string",
|
||||
"docstring": ""
|
||||
},
|
||||
"kind": {
|
||||
"name": "kind",
|
||||
"kind": "property",
|
||||
"path": "models.DocObject.kind",
|
||||
"signature": "kind: DocKind",
|
||||
"docstring": ""
|
||||
},
|
||||
"members": {
|
||||
"name": "members",
|
||||
"kind": "property",
|
||||
"path": "models.DocObject.members",
|
||||
"signature": "members: Record<string, DocObject>",
|
||||
"docstring": ""
|
||||
},
|
||||
"name": {
|
||||
"name": "name",
|
||||
"kind": "property",
|
||||
"path": "models.DocObject.name",
|
||||
"signature": "name: string",
|
||||
"docstring": ""
|
||||
},
|
||||
"path": {
|
||||
"name": "path",
|
||||
"kind": "property",
|
||||
"path": "models.DocObject.path",
|
||||
"signature": "path: string",
|
||||
"docstring": ""
|
||||
},
|
||||
"signature": {
|
||||
"name": "signature",
|
||||
"kind": "property",
|
||||
"path": "models.DocObject.signature",
|
||||
"signature": "signature: string",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
},
|
||||
"DocProject": {
|
||||
"name": "DocProject",
|
||||
"kind": "interface",
|
||||
"path": "models.DocProject",
|
||||
"signature": "DocProject",
|
||||
"docstring": "The root semantic model produced by the loader.",
|
||||
"members": {
|
||||
"modules": {
|
||||
"name": "modules",
|
||||
"kind": "property",
|
||||
"path": "models.DocProject.modules",
|
||||
"signature": "modules: DocModule[]",
|
||||
"docstring": ""
|
||||
},
|
||||
"name": {
|
||||
"name": "name",
|
||||
"kind": "property",
|
||||
"path": "models.DocProject.name",
|
||||
"signature": "name: string",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
},
|
||||
"DocKind": {
|
||||
"name": "DocKind",
|
||||
"kind": "type-alias",
|
||||
"path": "models.DocKind",
|
||||
"signature": "DocKind: \"module\" | \"namespace\" | \"class\" | \"interface\" | \"enum\" | \"enum-member\" | \"type-alias\" | \"variable\" | \"function\" | \"method\" | \"accessor\" | \"property\" | \"constructor\" | \"signature\" | \"parameter\" | \"component\" | \"hook\" | \"unknown\"",
|
||||
"docstring": "The set of documentable symbol kinds recognized by doc-weaver."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
44
doc-weaver/mcp/modules/models.typedoc.json
Normal file
44
doc-weaver/mcp/modules/models.typedoc.json
Normal file
@@ -0,0 +1,44 @@
|
||||
{
|
||||
"module": "models.typedoc",
|
||||
"content": {
|
||||
"path": "models.typedoc",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"RefKind": {
|
||||
"name": "RefKind",
|
||||
"kind": "component",
|
||||
"path": "models.typedoc.RefKind",
|
||||
"signature": "RefKind: typeof ReflectionKind",
|
||||
"docstring": "Re-export TypeDoc's numeric reflection kinds for internal use."
|
||||
},
|
||||
"collectModules": {
|
||||
"name": "collectModules",
|
||||
"kind": "function",
|
||||
"path": "models.typedoc.collectModules",
|
||||
"signature": "collectModules(project: any): any[]",
|
||||
"docstring": ""
|
||||
},
|
||||
"reflectionKindName": {
|
||||
"name": "reflectionKindName",
|
||||
"kind": "function",
|
||||
"path": "models.typedoc.reflectionKindName",
|
||||
"signature": "reflectionKindName(kind: number): string",
|
||||
"docstring": ""
|
||||
},
|
||||
"resolveModulePath": {
|
||||
"name": "resolveModulePath",
|
||||
"kind": "function",
|
||||
"path": "models.typedoc.resolveModulePath",
|
||||
"signature": "resolveModulePath(mod: any, project: any): string",
|
||||
"docstring": ""
|
||||
},
|
||||
"sanitize": {
|
||||
"name": "sanitize",
|
||||
"kind": "function",
|
||||
"path": "models.typedoc.sanitize",
|
||||
"signature": "sanitize(value: string): string",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
37
doc-weaver/mcp/modules/renderers.docstring.json
Normal file
37
doc-weaver/mcp/modules/renderers.docstring.json
Normal file
@@ -0,0 +1,37 @@
|
||||
{
|
||||
"module": "renderers.docstring",
|
||||
"content": {
|
||||
"path": "renderers.docstring",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"classifyReact": {
|
||||
"name": "classifyReact",
|
||||
"kind": "function",
|
||||
"path": "renderers.docstring.classifyReact",
|
||||
"signature": "classifyReact(name: string, kind: string): string",
|
||||
"docstring": ""
|
||||
},
|
||||
"mapKind": {
|
||||
"name": "mapKind",
|
||||
"kind": "function",
|
||||
"path": "renderers.docstring.mapKind",
|
||||
"signature": "mapKind(kind: number): string",
|
||||
"docstring": ""
|
||||
},
|
||||
"renderComment": {
|
||||
"name": "renderComment",
|
||||
"kind": "function",
|
||||
"path": "renderers.docstring.renderComment",
|
||||
"signature": "renderComment(comment: any): string",
|
||||
"docstring": ""
|
||||
},
|
||||
"renderParts": {
|
||||
"name": "renderParts",
|
||||
"kind": "function",
|
||||
"path": "renderers.docstring.renderParts",
|
||||
"signature": "renderParts(parts: undefined | any[]): string",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
81
doc-weaver/mcp/modules/renderers.human-docs.json
Normal file
81
doc-weaver/mcp/modules/renderers.human-docs.json
Normal file
@@ -0,0 +1,81 @@
|
||||
{
|
||||
"module": "renderers.human-docs",
|
||||
"content": {
|
||||
"path": "renderers.human-docs",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"HumanDocsOptions": {
|
||||
"name": "HumanDocsOptions",
|
||||
"kind": "interface",
|
||||
"path": "renderers.human-docs.HumanDocsOptions",
|
||||
"signature": "HumanDocsOptions",
|
||||
"docstring": "Generate the human-facing documentation site using TypeDoc.\n\nTypeDoc plays the same role for doc-weaver that MkDocs plays for\ndoc-forge: it renders the compiled model into a browsable site. The\nmachine-facing output (MCP JSON) is produced separately.",
|
||||
"members": {
|
||||
"entryPoints": {
|
||||
"name": "entryPoints",
|
||||
"kind": "property",
|
||||
"path": "renderers.human-docs.HumanDocsOptions.entryPoints",
|
||||
"signature": "entryPoints: string[]",
|
||||
"docstring": ""
|
||||
},
|
||||
"entryPointStrategy": {
|
||||
"name": "entryPointStrategy",
|
||||
"kind": "property",
|
||||
"path": "renderers.human-docs.HumanDocsOptions.entryPointStrategy",
|
||||
"signature": "entryPointStrategy: \"resolve\" | \"expand\" | \"merge\" | \"packages\"",
|
||||
"docstring": "TypeDoc entry-point strategy. Defaults to 'resolve'."
|
||||
},
|
||||
"name": {
|
||||
"name": "name",
|
||||
"kind": "property",
|
||||
"path": "renderers.human-docs.HumanDocsOptions.name",
|
||||
"signature": "name: string",
|
||||
"docstring": ""
|
||||
},
|
||||
"options": {
|
||||
"name": "options",
|
||||
"kind": "property",
|
||||
"path": "renderers.human-docs.HumanDocsOptions.options",
|
||||
"signature": "options: string",
|
||||
"docstring": "Optional path to a typedoc.json config."
|
||||
},
|
||||
"out": {
|
||||
"name": "out",
|
||||
"kind": "property",
|
||||
"path": "renderers.human-docs.HumanDocsOptions.out",
|
||||
"signature": "out: string",
|
||||
"docstring": ""
|
||||
},
|
||||
"plugin": {
|
||||
"name": "plugin",
|
||||
"kind": "property",
|
||||
"path": "renderers.human-docs.HumanDocsOptions.plugin",
|
||||
"signature": "plugin: string[]",
|
||||
"docstring": "Optional TypeDoc plugins (e.g. typedoc-plugin-markdown)."
|
||||
},
|
||||
"skipErrorChecking": {
|
||||
"name": "skipErrorChecking",
|
||||
"kind": "property",
|
||||
"path": "renderers.human-docs.HumanDocsOptions.skipErrorChecking",
|
||||
"signature": "skipErrorChecking: boolean",
|
||||
"docstring": "Skip TypeScript error checking. Defaults to true."
|
||||
},
|
||||
"tsconfig": {
|
||||
"name": "tsconfig",
|
||||
"kind": "property",
|
||||
"path": "renderers.human-docs.HumanDocsOptions.tsconfig",
|
||||
"signature": "tsconfig: string",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
},
|
||||
"generateHumanDocs": {
|
||||
"name": "generateHumanDocs",
|
||||
"kind": "function",
|
||||
"path": "renderers.human-docs.generateHumanDocs",
|
||||
"signature": "generateHumanDocs(opts: HumanDocsOptions): Promise<string>",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
97
doc-weaver/mcp/modules/renderers.mcp-renderer.json
Normal file
97
doc-weaver/mcp/modules/renderers.mcp-renderer.json
Normal file
@@ -0,0 +1,97 @@
|
||||
{
|
||||
"module": "renderers.mcp-renderer",
|
||||
"content": {
|
||||
"path": "renderers.mcp-renderer",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"TypeDocJsonToMCP": {
|
||||
"name": "TypeDocJsonToMCP",
|
||||
"kind": "class",
|
||||
"path": "renderers.mcp-renderer.TypeDocJsonToMCP",
|
||||
"signature": "TypeDocJsonToMCP",
|
||||
"docstring": "Transform a TypeDoc serialized reflection JSON into a doc-forge-compatible\nMCP bundle.\n\nThe produced shape matches doc-forge exactly:\n\n- `index.json` -> `{ project, type, modules_count, source }`\n- `nav.json` -> `[ { module, resource } ]` with `docs://modules/{module}`\n- `modules/*.json` -> `{ module, content: { path, docstring, objects } }`\n\nObjects are rendered recursively with\n`{ name, kind, path, signature, docstring, members? }`.",
|
||||
"members": {
|
||||
"constructor": {
|
||||
"name": "constructor",
|
||||
"kind": "constructor",
|
||||
"path": "renderers.mcp-renderer.TypeDocJsonToMCP.constructor",
|
||||
"signature": "TypeDocJsonToMCP(project: any, projectName?: string): TypeDocJsonToMCP",
|
||||
"docstring": ""
|
||||
},
|
||||
"project": {
|
||||
"name": "project",
|
||||
"kind": "property",
|
||||
"path": "renderers.mcp-renderer.TypeDocJsonToMCP.project",
|
||||
"signature": "project: any",
|
||||
"docstring": ""
|
||||
},
|
||||
"projectName": {
|
||||
"name": "projectName",
|
||||
"kind": "property",
|
||||
"path": "renderers.mcp-renderer.TypeDocJsonToMCP.projectName",
|
||||
"signature": "projectName: string",
|
||||
"docstring": ""
|
||||
},
|
||||
"collectMembers": {
|
||||
"name": "collectMembers",
|
||||
"kind": "method",
|
||||
"path": "renderers.mcp-renderer.TypeDocJsonToMCP.collectMembers",
|
||||
"signature": "collectMembers(ref: any, parentPath: string): Record<string, unknown>",
|
||||
"docstring": ""
|
||||
},
|
||||
"renderModule": {
|
||||
"name": "renderModule",
|
||||
"kind": "method",
|
||||
"path": "renderers.mcp-renderer.TypeDocJsonToMCP.renderModule",
|
||||
"signature": "renderModule(mod: any, modPath: string): Record<string, unknown>",
|
||||
"docstring": ""
|
||||
},
|
||||
"renderObject": {
|
||||
"name": "renderObject",
|
||||
"kind": "method",
|
||||
"path": "renderers.mcp-renderer.TypeDocJsonToMCP.renderObject",
|
||||
"signature": "renderObject(ref: any, parentPath: string): Record<string, unknown>",
|
||||
"docstring": ""
|
||||
},
|
||||
"transform": {
|
||||
"name": "transform",
|
||||
"kind": "method",
|
||||
"path": "renderers.mcp-renderer.TypeDocJsonToMCP.transform",
|
||||
"signature": "transform(): McpBundle",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
},
|
||||
"McpBundle": {
|
||||
"name": "McpBundle",
|
||||
"kind": "interface",
|
||||
"path": "renderers.mcp-renderer.McpBundle",
|
||||
"signature": "McpBundle",
|
||||
"docstring": "",
|
||||
"members": {
|
||||
"index": {
|
||||
"name": "index",
|
||||
"kind": "property",
|
||||
"path": "renderers.mcp-renderer.McpBundle.index",
|
||||
"signature": "index: Record<string, unknown>",
|
||||
"docstring": ""
|
||||
},
|
||||
"modules": {
|
||||
"name": "modules",
|
||||
"kind": "property",
|
||||
"path": "renderers.mcp-renderer.McpBundle.modules",
|
||||
"signature": "modules: Record<string, { content: Record<string, unknown>; module: string }>",
|
||||
"docstring": ""
|
||||
},
|
||||
"nav": {
|
||||
"name": "nav",
|
||||
"kind": "property",
|
||||
"path": "renderers.mcp-renderer.McpBundle.nav",
|
||||
"signature": "nav: { module: string; resource: string }[]",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
30
doc-weaver/mcp/modules/renderers.signature.json
Normal file
30
doc-weaver/mcp/modules/renderers.signature.json
Normal file
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"module": "renderers.signature",
|
||||
"content": {
|
||||
"path": "renderers.signature",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"bestSignature": {
|
||||
"name": "bestSignature",
|
||||
"kind": "function",
|
||||
"path": "renderers.signature.bestSignature",
|
||||
"signature": "bestSignature(ref: any): string",
|
||||
"docstring": ""
|
||||
},
|
||||
"renderSignature": {
|
||||
"name": "renderSignature",
|
||||
"kind": "function",
|
||||
"path": "renderers.signature.renderSignature",
|
||||
"signature": "renderSignature(signature: any, fallbackName?: string): string",
|
||||
"docstring": ""
|
||||
},
|
||||
"renderType": {
|
||||
"name": "renderType",
|
||||
"kind": "function",
|
||||
"path": "renderers.signature.renderType",
|
||||
"signature": "renderType(type: any): string",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
67
doc-weaver/mcp/modules/servers.mcp-server.json
Normal file
67
doc-weaver/mcp/modules/servers.mcp-server.json
Normal file
@@ -0,0 +1,67 @@
|
||||
{
|
||||
"module": "servers.mcp-server",
|
||||
"content": {
|
||||
"path": "servers.mcp-server",
|
||||
"docstring": "",
|
||||
"objects": {
|
||||
"MCPServer": {
|
||||
"name": "MCPServer",
|
||||
"kind": "class",
|
||||
"path": "servers.mcp-server.MCPServer",
|
||||
"signature": "MCPServer",
|
||||
"docstring": "MCP server serving a pre-generated doc-weaver bundle.\n\nMirrors `docforge.servers.MCPServer`: it exposes read-only documentation\nresources and a single health-check tool.\n\nResources:\n- `docs://index` - project metadata\n- `docs://nav` - navigation structure\n- `docs://modules/{module}` - individual module documentation",
|
||||
"members": {
|
||||
"constructor": {
|
||||
"name": "constructor",
|
||||
"kind": "constructor",
|
||||
"path": "servers.mcp-server.MCPServer.constructor",
|
||||
"signature": "MCPServer(mcpRoot: string, name: string): MCPServer",
|
||||
"docstring": ""
|
||||
},
|
||||
"mcpRoot": {
|
||||
"name": "mcpRoot",
|
||||
"kind": "property",
|
||||
"path": "servers.mcp-server.MCPServer.mcpRoot",
|
||||
"signature": "mcpRoot: string",
|
||||
"docstring": ""
|
||||
},
|
||||
"server": {
|
||||
"name": "server",
|
||||
"kind": "property",
|
||||
"path": "servers.mcp-server.MCPServer.server",
|
||||
"signature": "server: McpServer",
|
||||
"docstring": ""
|
||||
},
|
||||
"readJson": {
|
||||
"name": "readJson",
|
||||
"kind": "method",
|
||||
"path": "servers.mcp-server.MCPServer.readJson",
|
||||
"signature": "readJson(relPath: string, uri: string): { contents: { mimeType: string; text: string; uri: string }[] }",
|
||||
"docstring": ""
|
||||
},
|
||||
"registerResources": {
|
||||
"name": "registerResources",
|
||||
"kind": "method",
|
||||
"path": "servers.mcp-server.MCPServer.registerResources",
|
||||
"signature": "registerResources(): void",
|
||||
"docstring": ""
|
||||
},
|
||||
"registerTools": {
|
||||
"name": "registerTools",
|
||||
"kind": "method",
|
||||
"path": "servers.mcp-server.MCPServer.registerTools",
|
||||
"signature": "registerTools(): void",
|
||||
"docstring": ""
|
||||
},
|
||||
"run": {
|
||||
"name": "run",
|
||||
"kind": "method",
|
||||
"path": "servers.mcp-server.MCPServer.run",
|
||||
"signature": "run(): Promise<void>",
|
||||
"docstring": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user