Skip to content

Commit c2b3ebe

Browse files
authored
docs: improve get started guide (#9)
1 parent cb100e6 commit c2b3ebe

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

docs/index.mdx

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Getting Started with @hyperweb/mcp-server
22

3-
Welcome to the documentation for the Hyperweb MCP Server (`@hyperweb/mcp-server`). This server implements the Model Context Protocol (MCP) to help you use Hyperweb platform tools more effectively and easily with AI agents.
3+
Welcome to the documentation for the Hyperweb MCP Server (`@hyperweb/mcp-server`). The Hyperweb MCP Server is a [Model Context Protocol](https://modelcontextprotocol.io/introduction) server that provides seemless integration with Web3 tools in Hyperweb Ecosystem and Cosmos Ecosystem, enabling advanced interaction capabilities with AI agents for developers.
44

5-
## Overview
5+
## Use Cases
66

77
The Agentic Tools MCP Server, also known as `@hyperweb/mcp-server`, provides a suite of functionalities focused on Cosmos SDK based chains and the broader interchain ecosystem. It allows for interactions with:
88

@@ -13,21 +13,24 @@ The Agentic Tools MCP Server, also known as `@hyperweb/mcp-server`, provides a s
1313

1414
This server aims to simplify common developer workflows and provide programmatic access to essential data and operations within the Hyperweb and Cosmos environments.
1515

16-
## Setup
16+
## Prerequisites
1717

18-
To run the Hyperweb MCP server using npx, use the following command in your terminal:
18+
Development:
1919

20-
```bash
21-
npx -y @hyperweb/mcp-server@latest
22-
```
20+
- Node.js (v20 or higher)
21+
- pnpm (v10 or higher)
22+
23+
MCP server use:
2324

24-
This command will download and run the latest version of the server.
25+
- Any IDE or editor that supports MCP protocol, for example [Cursor](https://docs.cursor.com/context/model-context-protocol), [Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#model-context-protocol-mcp) or [Claude Desktop](https://modelcontextprotocol.io/quickstart/user)
2526

2627
## Usage with AI Clients (Cursor or Claude Desktop)
2728

2829
To integrate the Hyperweb MCP Server with AI clients like Cursor or Claude Desktop, you need to add the following configuration to your client's settings. This allows the AI client to discover and use the tools provided by this MCP server.
2930

30-
For more information, you can refer to the [Cursor MCP documentation](https://docs.cursor.com/context/model-context-protocol) or the [Claude Desktop MCP guide](https://modelcontextprotocol.io/quickstart/user).
31+
We will demonstrate the usage of the Hyperweb MCP Server with Cursor/Claude Desktop in this guide.
32+
33+
For more information, you can refer to the [Cursor MCP documentation](https://docs.cursor.com/context/model-context-protocol), [Windsurf MCP guide](https://docs.windsurf.com/windsurf/cascade/mcp#model-context-protocol-mcp) or the [Claude Desktop MCP guide](https://modelcontextprotocol.io/quickstart/user).
3134

3235
**Standard Configuration:**
3336

@@ -36,7 +39,7 @@ For more information, you can refer to the [Cursor MCP documentation](https://do
3639
"mcpServers": {
3740
"hyperweb-mcp-server": {
3841
"command": "npx",
39-
"args": ["-y", "@hyperweb/mcp-server@latest"]
42+
"args": ["-y", "@hyperweb/mcp-server@latest"] // Make sure to use the latest version
4043
}
4144
}
4245
}
@@ -51,12 +54,16 @@ If you are on Windows, you might need to use this alternative configuration:
5154
"mcpServers": {
5255
"hyperweb-mcp-server": {
5356
"command": "cmd",
54-
"args": ["/k", "npx", "-y", "@hyperweb/mcp-server@latest"]
57+
"args": ["/k", "npx", "-y", "@hyperweb/mcp-server@latest"] // Make sure to use the latest version
5558
}
5659
}
5760
}
5861
```
5962

63+
After setting up the configuration, the MCP server will be available in the MCP clients (Cursor/Claude Desktop) and you will be able to interact with it through normal prompting.
64+
65+
The context will be detected and injected into the context of your conversation with AI agents and the tools will be available for use.
66+
6067
## Available Tools
6168

6269
This server provides a range of tools to assist with development in the Hyperweb and Cosmos ecosystems. For a detailed list of all available tools, their descriptions, and parameters, please refer to the [API Reference](./references).

0 commit comments

Comments
 (0)