Python API Reference
This page documents the Python API reference for mcp_fabric.
Local Fabric Context
-
class mcp_fabric.local.LocalFabric(*, transport='http-sse', host='127.0.0.1', port=None, adaptive_placement=False, adaptive_placement_client_allowlist=None, redis_url=None, server_count=None, load_threshold=None, auto_scale_threshold=None, session_ttl_ms=None, reconnect_grace_ms=None, on_disconnect=None, allow_public_bind=None, enforce_startup_security_audit=None, session_registry_backend=None, session_registry_file=None, session_registry_redis_key=None, server_instances=None, remote_base_urls=None, env=None, print_config=True, server_instance_id='stdio-server-1', keep_artifacts=False, log_level='info', startup_timeout=10.0, runtime_dir=None)[source]
Bases: object
-
client()[source]
-
property logs: list[str]
-
start()[source]
- Return type:
LocalFabric
-
stop()[source]
- Return type:
None
-
property url: str | None
Fabric Client
-
class mcp_fabric.client.FabricClient(base_url, *, timeout=10.0)[source]
Bases: object
-
health()[source]
- Return type:
dict[str, Any]
-
initialize(client_id=None, runtime_mode=None, runtime_hints=None)[source]
- Return type:
FabricSession
-
message(body)[source]
- Return type:
dict[str, Any]
-
observability()[source]
- Return type:
dict[str, Any]
-
sessions()[source]
- Return type:
dict[str, Any]
-
tools_call(session_id, *, name, arguments=None)[source]
- Return type:
dict[str, Any]
-
tools_list(session_id)[source]
- Return type:
dict[str, Any]
Runtime Gateway Manager
-
class mcp_fabric.runtime.LocalFabricGateway(host='127.0.0.1', port=None, adaptive_placement=False, adaptive_placement_client_allowlist=None, redis_url=None, server_count=None, load_threshold=None, auto_scale_threshold=None, session_ttl_ms=None, reconnect_grace_ms=None, on_disconnect=None, allow_public_bind=None, enforce_startup_security_audit=None, session_registry_backend=None, session_registry_file=None, session_registry_redis_key=None, server_instances=None, remote_base_urls=None, env=None, print_config=True, keep_artifacts=False, log_level='info', startup_timeout=10.0, runtime_dir=None)[source]
Bases: object
-
client()[source]
- Return type:
FabricClient
-
start()[source]
- Return type:
LocalFabricGateway
-
stop()[source]
- Return type:
None
-
mcp_fabric.runtime.defaulted_report(value, default_key)[source]
- Return type:
dict[str, object]
-
mcp_fabric.runtime.ensure_node_runtime()[source]
- Return type:
None
-
mcp_fabric.runtime.ensure_runtime_dependencies(runtime_dir)[source]
- Return type:
None
-
mcp_fabric.runtime.find_free_port(host)[source]
- Return type:
int
-
mcp_fabric.runtime.format_allowlist(value)[source]
- Return type:
str | None
-
mcp_fabric.runtime.list_runtime_npm_scripts(*, runtime_dir=None)[source]
- Return type:
dict[str, str]
-
mcp_fabric.runtime.print_runtime_config(transport, config)[source]
- Return type:
None
-
mcp_fabric.runtime.put_optional_env(env, name, value)[source]
- Return type:
None
-
mcp_fabric.runtime.redact(value)[source]
- Return type:
object
-
mcp_fabric.runtime.redact_mapping(values)[source]
- Return type:
dict[str, str]
-
mcp_fabric.runtime.report_value(value, source)[source]
- Return type:
dict[str, object]
-
mcp_fabric.runtime.run_runtime_npm_script(script, *, args=None, env=None, runtime_dir=None)[source]
- Return type:
int
-
mcp_fabric.runtime.wait_for_gateway_ready(client, process, logs, timeout)[source]
- Return type:
dict[str, Any]