Help us shape the future of Go! Take the 2026 Go Developer Survey

deepwiki

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 8, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package deepwiki adapts the public DeepWiki MCP server behind a narrow, product-owned read contract. Returned prose is untrusted derived context.

Index

Constants

View Source
const DefaultEndpoint = "https://mcp.deepwiki.com/mcp"

DefaultEndpoint is DeepWiki's unauthenticated public Streamable HTTP MCP endpoint.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	Endpoint string
	// contains filtered or unexported fields
}

Client calls a public DeepWiki MCP endpoint. An empty Endpoint uses DefaultEndpoint.

func (*Client) Read

func (c *Client) Read(ctx context.Context, req Request) (_ Response, err error)

Read performs one public DeepWiki tool call and returns text content only. It neither persists the response nor treats it as GitHub authority.

type Reader

type Reader interface {
	Read(context.Context, Request) (Response, error)
}

Reader performs an external DeepWiki read without writing to the local corpus.

type Request

type Request struct {
	Action       string
	Repository   string
	Repositories []string
	Question     string
}

Request selects one public DeepWiki read action. Structure and contents use Repository; question uses Repositories and Question.

type Response

type Response struct {
	Text      string
	SourceURL string
	Available bool
}

Response contains untrusted derived prose. Available is false for a provider-level tool error; transport and protocol failures are returned as errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL