Adds a root directory or resource.

Examples

:ok = MyClient.add_root("file:///project", "My Project")

@spec await_ready(String.t(), pos_integer()) :: :ok | {:error, :timeout}

等待命名 MCP server 完成初始化握手。

轮询 get_server_capabilities，直到非 nil 或超时。 就绪返回 :ok，超时返回 {:error, :timeout}。

Calls a specific tool by name with optional arguments.

Examples

{:ok, result} = MyClient.call_tool("search", %{query: "elixir"})

Cancels all pending requests.

Examples

:ok = MyClient.cancel_all_requests("shutting_down")

Cancels a specific request by ID.

Examples

:ok = MyClient.cancel_request("req-123")

@spec child_spec(map()) :: Supervisor.child_spec()

为命名 MCP server 连接构建 child spec。

参数

• server_config — 包含 :name（String）和 :transport（tuple）的 map

Clears all registered roots.

Examples

:ok = MyClient.clear_roots()

@spec client_name(String.t()) :: {:via, module(), {module(), term()}}

返回 MCP server client GenServer 的注册进程名（via-tuple）。

Closes the client connection gracefully.

Examples

:ok = MyClient.close()

Completes a partial result reference.

Examples

{:ok, result} = MyClient.complete(ref, "completed")

Gets a specific prompt by name with optional arguments.

Examples

{:ok, prompt} = MyClient.get_prompt("greeting", %{name: "Alice"})

Gets the server's declared capabilities.

Examples

{:ok, capabilities} = MyClient.get_server_capabilities()

Gets the server information including name and version.

Examples

{:ok, info} = MyClient.get_server_info()

Lists all available prompts from the server.

Options

• :cursor - Pagination cursor
• :timeout - Request timeout in milliseconds

Examples

{:ok, prompts} = MyClient.list_prompts()

Lists all available resource templates from the server.

Options

• :cursor - Pagination cursor
• :timeout - Request timeout in milliseconds

Examples

{:ok, resources} = MyClient.list_resources_templates()

Lists all available resources from the server.

Options

• :cursor - Pagination cursor
• :timeout - Request timeout in milliseconds

Examples

{:ok, resources} = MyClient.list_resources()

Lists all registered roots.

Examples

{:ok, roots} = MyClient.list_roots()

Lists all available tools from the server.

Options

• :cursor - Pagination cursor
• :timeout - Request timeout in milliseconds

Examples

{:ok, tools} = MyClient.list_tools()

Merges additional capabilities into the client.

Examples

:ok = MyClient.merge_capabilities(%{"experimental" => %{}})

Sends a ping request to the MCP server.

Options

• :timeout - Request timeout in milliseconds (default: 5000)

Examples

{:ok, :pong} = MyClient.ping()

Reads a specific resource by URI.

Examples

{:ok, content} = MyClient.read_resource("file:///path/to/file")

Registers a callback for log messages.

Examples

:ok = MyClient.register_log_callback(fn log -> IO.puts(log) end)

Registers a callback for progress updates.

Examples

:ok = MyClient.register_progress_callback("task-1", fn progress -> 
  IO.puts("Progress: #{progress}")
end)

Removes a root directory or resource.

Examples

:ok = MyClient.remove_root("file:///project")

Sends a progress update for a token.

Examples

:ok = MyClient.send_progress("task-1", 50, 100)

@spec server_call_tool(String.t(), String.t(), map() | nil, keyword()) ::
  {:ok, term()} | {:error, term()}

调用命名 MCP server 上的工具。

@spec server_list_resources(
  String.t(),
  keyword()
) :: {:ok, term()} | {:error, term()}

列出命名 MCP server 上的所有资源。

@spec server_list_tools(
  String.t(),
  keyword()
) :: {:ok, term()} | {:error, term()}

列出命名 MCP server 上的所有工具。

@spec server_read_resource(String.t(), String.t(), keyword()) ::
  {:ok, term()} | {:error, term()}

读取命名 MCP server 上的资源。

Sets the server's log level.

Examples

:ok = MyClient.set_log_level("debug")

@spec transport_name(String.t()) :: {:via, module(), {module(), term()}}

返回 MCP server transport 进程的注册进程名（via-tuple）。

Unregisters the log callback.

Unregisters a progress callback.