Skip to content

hypergriiiiid - #282

Merged
nick1udwig merged 3 commits into
mainfrom
Hypergrid-documentation
Jun 16, 2025
Merged

hypergriiiiid#282
nick1udwig merged 3 commits into
mainfrom
Hypergrid-documentation

Conversation

@humanizersequel

Copy link
Copy Markdown
Contributor

Slight reformatting of docs, adds Hypergrid documentation. LGTM

here we go
Comment thread src/hypergrid_overview.md Outdated
Providers compete on price and quality.

**Operators** - AI agents that discover and pay providers for services using USDC on Base.
Operators use MCP (Model Context Protocol) to interface with the Hypergrid network.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommend linking here to https://modelcontextprotocol.io, e.g. something like

Operators use [MCP (Model Context Protocol)](https://modelcontextprotocol.io) to ...
@@ -0,0 +1,106 @@
# Running an Operator Node

The Hypergrid protocol allows for *Operators* to make micropayments in USDC on the Base blockchain in exchange for services from *Providers*.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: better to say Base L2?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I see "Base blockchain" used more, and it's a little clearer to someone who might not know what an L2 is. Going to submit a version without this change, we can go in the other direction if you feel strongly about it

Comment thread src/hypergrid/running_operator_node.md Outdated
**2. Install Operator Client**

Once your node is booted, you'll be able to access the home screen, and from there you can navigate to the App Store.
This is an onchain registry of Hyperware applications similar to Hypergrid.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Hyperware applications similar to Hypergrid. -> Hyperware applications, including Hypergrid.

Comment thread src/hypergrid/running_provider_node.md Outdated

**1. Get a Hyperware node**

The Hypergrid Provider clent is built on top of Hyperware, a p2p application deployment platform, so in order to act as a provider you'll need to be runnning a Hyperware node.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

runnning has an extra n:

-> running

Comment thread src/hypergrid/running_provider_node.md Outdated
**1. Get a Hyperware node**

The Hypergrid Provider clent is built on top of Hyperware, a p2p application deployment platform, so in order to act as a provider you'll need to be runnning a Hyperware node.
The simplest way to obtain a running node is through our hosting solution, Valet, where we will run your node for you.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: obtain a running node -> obtain a node

Comment thread src/hypergrid/running_provider_node.md Outdated

The `~description` and `~instructions` notes merit deeper thought.
A description is how an agent will find your Provider.
If an agent with access to Hypergrid stumbles into a scenario where it thinks it might benefit by calling a Provider (maybe it doesn't have access to some data, wants to double check something specific, or needs a tool its local client doesn't have installed), it will search the Hypergrid registry and it will use the description field to do so.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can make less wordy like:

... access to Hypergrid thinks it might benefit by calling a Provider ...
It's possible to update this later, so be thoughtful but don't stress it too much.

Instructions tell the agent how to format a call to your provider.
You should be as detailed as possible so it "just works", notice how our weatherapi Provider has basically the entire call structure written out.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should provide one or both of:

  • Example(s) of good / bad description/instructions
  • Links to docs discussing how to make good description/instructions

There are a bunch of example MCP servers here: https://modelcontextprotocol.io/examples

but it requires clicking into the repos and looking at the files, e.g. https://github.com/modelcontextprotocol/servers/blob/d2b217ac4fb5d2b4c0ca60af5ca9ca7e6be0082e/src/filesystem/index.ts#L446-L555

and it might be confusing because there is more going on here than just description/instructions

I don't think this one is blocking, but I do think it is important (otherwise these directions are pretty abstract)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The photo linked there includes an example set of instructions, or should anyway.

Comment thread src/hypergrid/running_provider_node.md Outdated




Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Get rid of extra newlines

Comment thread src/hypergrid/running_provider_node.md Outdated
Hit the Register Provider Configuration button, and you're almost ready to go.

In the future, this will prompt you to sign a transaction in order to directly mint your Provider onchain.
To prevent spam while Hypergrid is in beta, we're using a Solana-style "proof of discord" mechanism: hit the copy button to copy the metadata for your provider, and link it to us in the provider-registration channel of the [Hyperware discord](https://discord.com/invite/KwNE58RKpg).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be simplified (i.e. probably remove solana reference)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LMFAO I forgot to delete that. Yes definitely should not make it through.

Comment thread src/hypergrid/running_provider_node.md Outdated
Hit the Register Provider Configuration button, and you're almost ready to go.

In the future, this will prompt you to sign a transaction in order to directly mint your Provider onchain.
To prevent spam while Hypergrid is in beta, we're using a Solana-style "proof of discord" mechanism: hit the copy button to copy the metadata for your provider, and link it to us in the provider-registration channel of the [Hyperware discord](https://discord.com/invite/KwNE58RKpg).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a problem here where users' API keys will be exposed when they post in the discord?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, and I should clarify that. What I'm asking them for is the metadata that would go onchain anyways, but we haven't set up permissionless registration yet, so proof-of-discord seemed expedient.

@nick1udwig
nick1udwig merged commit 1dcf438 into main Jun 16, 2025
@nick1udwig
nick1udwig deleted the Hypergrid-documentation branch June 16, 2025 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants