openvibers/openvibe.connect Commits

/.well-known/agent.json: what this site serves, for agents (SEO-2) (#26)

OP OpenVibers committed 10 days ago · 122596e7bc · 3 files, +36 −0

It answered 404. The shared agent layer serves server/agent-descriptor.js: the site's
purpose (its llms.txt summary), its API, docs and MCP where it has them, and its auth.

Changes

ddiff --git a/server/agent-descriptor.js b/server/agent-descriptor.js
nnew file mode 100644
iindex 0000000..aca1ab0
---- /dev/null
++++ b/server/agent-descriptor.js
@@@ -0,0 +1,14 @@
++'use strict';
++// What OpenVibe Connect tells an agent about itself (openvibe-shared/agent-layer): /.well-known/agent.json (SEO-2).
++// Every field is something this site really serves; the purpose is its own llms.txt summary.
++module.exports = {
++ id: "connect",
++ name: "OpenVibe Connect",
++ purpose: "Share one port on your computer at https://<name>--<username>.openvibe.website, behind OpenVibe sign-in; programs pass with a share's API key, MCP clients sign in with OAuth.",
++ home: "https://connect.openvibe.website",
++ site: "connect.openvibe.website",
++ api: "/api/v1",
++ policy: {
++ auth: ["Network OIDC"],
++ },
++};
ddiff --git a/server/app.js b/server/app.js
iindex 8456f45..d343e55 100644
---- a/server/app.js
++++ b/server/app.js
@@@ -159,6 +159,9 @@ async function createApp(opts = {}) {
log.error('[OpenVibe.Connect] share request failed:', err && err.message);
if (!res.headersSent) { res.statusCode = 502; res.end('Something went wrong on our side.'); } else res.destroy();
});
++ // /.well-known/agent.json (openvibe-shared/agent-layer, SEO-2): what this site serves, for agents.
++ // After the share hosts: a share's own /.well-known/agent.json belongs to the share.
++ require('openvibe-shared/agent-layer').mount(app, { descriptor: require('./agent-descriptor') });
});
const release = require('openvibe-shared/release').createRelease({ service: 'connect', root: path.join(__dirname, '..') });
ddiff --git a/test/agent-json.test.js b/test/agent-json.test.js
nnew file mode 100644
iindex 0000000..8f3e149
---- /dev/null
++++ b/test/agent-json.test.js
@@@ -0,0 +1,19 @@
++'use strict';
++// SEO-2: /.well-known/agent.json answered 404 here (11-03 check of all 55 sites). The shared agent layer serves this
++// site's descriptor; every field is something it really serves.
++const assert = require('assert');
++const fs = require('fs');
++const path = require('path');
++const descriptor = require('../server/agent-descriptor');
++const { agentManifest } = require('openvibe-shared/agent-layer');
++
++const m = agentManifest(descriptor);
++assert.strictEqual(m.network, 'OpenVibe');
++assert.strictEqual(m.home, 'https://connect.openvibe.website');
++assert.ok(m.purpose && m.purpose.length > 40, 'a purpose');
++assert.ok(/^https:\/\//.test(m.api), 'its API, absolute');
++assert.strictEqual(m.llms, 'https://connect.openvibe.website/llms.txt');
++assert.ok(Array.isArray(m.policy.auth) && m.policy.auth.length, 'how it is called');
++const app = fs.readFileSync(path.join(__dirname, '..', 'server', 'app.js'), 'utf8');
++assert.match(app, /require\('openvibe-shared\/agent-layer'\)\.mount\(app, \{ descriptor: require\('\.\/agent-descriptor'\) \}\);/);
++console.log('agent.json: ok');