Skip to content

Agent Mesh

update docs

Antonio Ojeae3ede2b26256
diff --git a/README.md b/README.md
index a71e6eb8..f83b857c 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
SAM is a minimal libp2p-based mesh with two binaries:
- `sam-hub`: OIDC bridge + Biscuit issuer + connection gater
-- `sam-node`: node identity/login flow + mesh node runtime
+- `sam-node`: node identity/login flow + mesh node runtime + local MCP server
The current repository intentionally focuses on basic functionality and testability.
@@ -47,6 +47,18 @@ Or pass a token directly:
./bin/sam-node run --token <identity-biscuit>
```
+## Local MCP Server
+
+Each `sam-node` exposes a Model Context Protocol (MCP) server over a Unix domain socket to allow local processes to discover the capabilities of the local agent and get information from the mesh.
+
+By default, the socket listens at `<datadir>/mcp.sock`. You can change this with the `--mcp-socket` flag.
+
+To query the mesh info via the MCP server, you can use the `mcp-client` tool provided in the repository:
+
+```bash
+./bin/mcp-client -socket /path/to/mcp.sock
+```
+
## Testing
```bash
diff --git a/docs/README.md b/docs/README.md
index 434fcf1a..be4b96e3 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -14,6 +14,8 @@ The documentation here is intentionally small and aligned with what is implement
3. Persist identity in local node store
4. Run long-lived hub and node processes
5. Run local and containerized BATS tests
+6. Expose local tools and mesh info via MCP server on a Unix socket
+7. Automated peer discovery via DHT and GossipSub events
## Start Here
diff --git a/docs/index.html b/docs/index.html
index 122683f0..b7e48fcf 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -16,16 +16,17 @@
-->
<html lang="en">
+
<head>
<meta charset="UTF-8">
<title>SAM - Sovereign Agent Mesh</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Zero-Trust Networking for Autonomous Agents" />
-
+
<!-- Docsify Stylesheet -->
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/dark.css" />
-
+
<!-- Custom Styles -->
<style>
:root {
@@ -35,46 +36,56 @@
--border-color: #4f46e5;
--code-color: #1f2937;
}
-
+
body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;
}
-
+
.sidebar {
background-color: #0f172a;
border-right: 1px solid var(--border-color);
}
-
+
.markdown-section h1 {
border-bottom: 2px solid var(--primary-color);
}
-
+
.markdown-section code {
background-color: var(--code-color);
padding: 2px 6px;
border-radius: 3px;
}
-
+
.markdown-section pre code {
background-color: #1e293b;
color: #e2e8f0;
}
</style>
+ <!-- Google tag (gtag.js) -->
+ <script async src="https://www.googletagmanager.com/gtag/js?id=G-F9G8NX0SBT"></script>
+ <script>
+ window.dataLayer = window.dataLayer || [];
+ function gtag() { dataLayer.push(arguments); }
+ gtag('js', new Date());
+
+ gtag('config', 'G-F9G8NX0SBT');
+ </script>
</head>
+
<body>
<div id="app">Loading SAM documentation...</div>
-
+
<script>
window.$docsify = {
name: '<img src="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text x=%2210%22 y=%2275%22 font-size=%2280%22 fill=%22%236366f1%22>⚡</text></svg>" style="height: 2rem; margin-right: 8px;"/> SAM',
- repo: 'https://github.com/aojea/sam',
-
+ repo: 'https://github.com/google/sam',
+
// Documentation settings
loadSidebar: true,
loadNavbar: false,
coverpage: false,
auto2top: true,
-
+
// Search plugin
search: {
paths: 'auto',
@@ -82,12 +93,12 @@
noData: 'No matching results',
depth: 3,
},
-
+
// Sidebar configuration
maxLevel: 3,
subMaxLevel: 2,
sidebarDisplayLevel: 1,
-
+
// Markdown rendering
markdown: {
pedantic: false,
@@ -103,10 +114,10 @@
return '<pre class="hljs"><code class="language-' + lang + '">' + Docsify.escapeHtml(code) + '</code></pre>';
},
},
-
+
// Plugins
plugins: [
- function(hook) {
+ function (hook) {
// Copy-to-clipboard for code blocks
hook.doneEach(() => {
const blocks = document.querySelectorAll('pre');
@@ -142,28 +153,29 @@
});
},
],
-
+
// Footer
footer: {
- copy: '<span>&copy; 2026 SAM Contributors. <a href="https://github.com/aojea/sam/blob/main/LICENSE">License</a></span>',
+ copy: '<span>&copy; 2026 SAM Contributors. <a href="https://github.com/google/sam/blob/main/LICENSE">License</a></span>',
auth: '',
pre: '<hr/>',
style: 'text-align: center;',
},
};
</script>
-
+
<!-- Docsify Core -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
-
+
<!-- Plugins -->
<script src="//cdn.jsdelivr.net/npm/docsify-search@1"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-footer-enh@1"></script>
-
+
<!-- Syntax Highlighting -->
<script src="//cdn.jsdelivr.net/npm/[email protected]/prism.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/[email protected]/components/prism-bash.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/[email protected]/components/prism-go.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/[email protected]/components/prism-json.min.js"></script>
</body>
-</html>
+
+</html>
\ No newline at end of file