Skip to content

Commit bda2879

Browse files
committed
Finished mcp setup, generation and testing
1 parent da5f2a2 commit bda2879

File tree

634 files changed

+300226
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

634 files changed

+300226
-3
lines changed
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Outputicjs MCP Server
2+
3+
This MCP server provides AI agents with tools to interact with blockchain through generated TypeScript clients.
4+
5+
**Note**: This MCP server contains a complete copy of the telescope generated codebase in `src/telescope/` for AI agents to reference, but uses mock implementations for demonstration. The telescope code is excluded from the build process.
6+
7+
## Installation
8+
9+
```bash
10+
cd outputicjs-mcp
11+
npm install
12+
npm run build
13+
```
14+
15+
## Usage with AI Agents
16+
17+
Add this configuration to your AI agent's MCP settings:
18+
19+
```json
20+
{
21+
"mcpServers": {
22+
"outputicjs-mcp-server": {
23+
"command": "node",
24+
"args": ["/path/to/outputicjs-mcp/dist/index.js"]
25+
}
26+
}
27+
}
28+
```
29+
30+
## Available Features
31+
32+
This MCP server provides:
33+
34+
- **Comprehensive Examples**: Reference implementations in `src/telescope-examples/`
35+
- **Function Generator Tool**: AI-powered tool that creates custom blockchain functions based on user requirements
36+
- **AI Guidance**: Prompt files to help AI agents understand blockchain development
37+
- **Complete Codebase**: Full telescope-generated code in `src/telescope/` for reference
38+
39+
**Note**: The MCP server uses a meta-tool approach - instead of predefined tools, it instructs agents to create custom functions by referencing the comprehensive examples.
40+
41+
## Development
42+
43+
```bash
44+
npm run build # Build the server
45+
npm run inspector # Run MCP inspector for testing
46+
npm run clean # Clean dist directory
47+
```
48+
49+
## Directory Structure
50+
51+
```
52+
outputicjs-mcp/
53+
├── src/
54+
│ ├── telescope/ # 📚 Telescope generated code (reference only, excluded from build)
55+
│ │ ├── cosmos/ # Full cosmos SDK modules
56+
│ │ │ ├── bank/ # Balance queries, transfers
57+
│ │ │ ├── staking/ # Validator operations
58+
│ │ │ └── ... # Other cosmos modules
59+
│ │ ├── osmosis/ # Osmosis DEX functionality
60+
│ │ ├── ibc/ # Inter-blockchain communication
61+
│ │ └── index.ts # Main exports
62+
│ ├── telescope-examples/ # 📖 Usage examples and patterns (excluded from build)
63+
│ │ ├── config-example.ts # Chain configuration setup
64+
│ │ ├── useBalance.ts # Balance query React hooks
65+
│ │ ├── useBalanceFunc.ts # Direct balance functions
66+
│ │ ├── getBalance.ts # Balance queries with examples
67+
│ │ ├── useAssets.ts # Multi-token balance queries
68+
│ │ ├── useStakingData.ts # Staking and delegation info
69+
│ │ ├── useValidators.ts # Validator queries
70+
│ │ ├── useVoting.ts # Governance proposals
71+
│ │ ├── useContractInfo.ts # Smart contract queries
72+
│ │ ├── useMyContracts.ts # User's contract list
73+
│ │ ├── useGrants.ts # Authorization grants
74+
│ │ └── useSendData.ts # Transaction preparation
75+
│ ├── prompts/ # 🤖 Agent instruction files
76+
│ │ ├── codegen-usage.md # Telescope usage guide
77+
│ │ ├── agent-guidelines.md # Best practices for agents
78+
│ │ └── chains.json # Chain registry data
79+
│ ├── index.ts # MCP server with function generator tool
80+
│ └── telescope-loader.ts # Utility for dynamic code loading
81+
├── dist/ # Compiled JavaScript (excludes telescope/ and telescope-examples/)
82+
└── package.json
83+
```
84+
85+
The `src/telescope/` and `src/telescope-examples/` directories contain reference code for AI agents but are excluded from the TypeScript build process.
86+
87+
Generated by [Telescope](https://github.com/hyperweb-io/telescope) 🔭
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/usr/bin/env node
2+
export {};
3+
//# sourceMappingURL=index.d.ts.map

__fixtures__/v-next/outputicjs-mcp/dist/index.d.ts.map

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

__fixtures__/v-next/outputicjs-mcp/dist/index.js

Lines changed: 278 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)