-
Notifications
You must be signed in to change notification settings - Fork 5
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Add ETHID-MCP Documentation and Reorganize AI Tools
Overview
We need to add comprehensive documentation for the ethid-mcp server (an MCP server for EFP, EIK, ENS, and SIWE) and create a new "AI Tools" category in our documentation. This will also involve moving the existing llms.txt documentation to this new category.
Repository Information
- Source Repository: ethereumfollowprotocol/ethid-mcp
- Description: An MCP (Model Context Protocol) server for EFP, EIK, ENS, and SIWE
- Language: TypeScript
- Status: Active development, recently restructured (July 2025)
Required Documentation Structure
1. Create New "AI Tools" Category
- Create a new top-level category called "AI Tools" in the documentation navigation
- This category will house both the new ethid-mcp documentation and the existing llms.txt documentation
2. Move Existing Content
- Move the current
llms.txtdocumentation from its current location to the new "AI Tools" category - Ensure all internal links are updated appropriately
3. Add ETHID-MCP Documentation
The ethid-mcp documentation should include the following pages:
3.1 Overview Page (ai-tools/ethid-mcp/index.mdx)
- What is ETHID-MCP: Introduction to the Model Context Protocol server
- Purpose: Explain how it enables AI tools (Claude Desktop, etc.) to interact with EFP, EIK, ENS, and SIWE
- Key Benefits: Real-time Ethereum identity data access, social graph exploration, ENS resolution
- Use Cases: AI-powered dApps, social analytics, identity verification
3.2 Installation Guide (ai-tools/ethid-mcp/installation.mdx)
- Prerequisites: Node.js, npm/yarn requirements
- Installation Methods:
- NPM package installation
- Local development setup
- Docker deployment (if available)
- Claude Desktop Integration: Step-by-step configuration for Claude Desktop
- Other MCP Clients: Configuration for other MCP-compatible clients
- Environment Configuration: Required environment variables and API keys
3.3 Available Tools (ai-tools/ethid-mcp/tools.mdx)
Document all 22+ available tools, organized by category:
Profile & Stats Tools:
getProfileStats- Get follower/following countsfetchAccount- Complete account information including ENS recordsfetchBulkAccounts- Bulk reverse resolution of addresses to ENS namesfetchProfileBadges- Achievement badges and recognitionsfetchProfileLists- Follow lists associated with an address
Social Graph Tools:
getFollowers- Get followers list with filtering and sortinggetFollowing- Get following list with filtering and sortingcheckFollowing- Check if address is following anothercheckFollower- Check follower relationshipsfetchRecommendations- Personalized account recommendationsfetchLeaderboard- Top accounts by various metrics
List Management Tools:
fetchAllFollowings- Export complete follow list datafetchListsForUser- Get all follow lists for a user
Tag System Tools:
fetchFollowingTags- Tags applied to followed accountsfetchFollowerTags- Tags applied by followers
Notification Tools:
fetchNotifications- Recent social activity notifications
Context & Guidance Tools:
searchContexts- Search EFP documentationgetBestPractices- Usage recommendationsgetUsagePattern- Common usage patternsgetToolGuidance- Task-specific tool recommendationsgetEfficiencyTips- Performance optimization
3.4 Usage Examples (ai-tools/ethid-mcp/examples.mdx)
- Basic Profile Lookup: Getting profile stats and account info
- Social Graph Analysis: Finding mutual connections, analyzing follower networks
- ENS Resolution: Converting addresses to ENS names in bulk
- Tag-based Filtering: Using tags to organize and filter follows
- Leaderboard Queries: Finding top accounts by various metrics
- Notification Monitoring: Tracking social activity changes
- Performance Optimization: Bulk operations and caching strategies
3.5 Best Practices (ai-tools/ethid-mcp/best-practices.mdx)
- Performance Optimization: Pagination, batching, caching strategies
- Rate Limiting: Respecting API limits
- Error Handling: Retry logic and graceful degradation
- Data Analysis Patterns: Effective social graph analysis techniques
- ENS Resolution Best Practices: Efficient address-to-name conversion
- Security Considerations: Safe handling of addresses and data
3.6 API Reference (ai-tools/ethid-mcp/api-reference.mdx)
- Complete tool reference with parameters, return types, and examples
- Error codes and troubleshooting
- Rate limits and usage quotas
- Data formats and schemas
3.7 Integration Guide (ai-tools/ethid-mcp/integration.mdx)
- Claude Desktop: Detailed setup and configuration
- Cursor IDE: Integration instructions
- Other MCP Clients: General integration guidance
- Custom Applications: Building applications with ethid-mcp
- Troubleshooting: Common issues and solutions
Technical Requirements
Documentation Format
- Use MDX format for all documentation files
- Include interactive code examples where appropriate
- Add proper TypeScript type definitions for examples
- Include screenshots for setup processes
Navigation Updates
- Update the main navigation to include "AI Tools" category
- Ensure proper ordering and categorization
- Update any existing cross-references
SEO and Discoverability
- Add appropriate meta tags and descriptions
- Include relevant keywords for AI tools, MCP, EFP, ENS, SIWE
- Update sitemap and search indexing
Content Sources
- Repository: https://github.com/ethereumfollowprotocol/ethid-mcp
- Recent commits show active development and restructuring
- Use the actual tool implementations as the source of truth for API documentation
- Reference existing EFP and EIK documentation for context
Acceptance Criteria
- New "AI Tools" category created in documentation navigation
- Existing llms.txt documentation moved to AI Tools category
- Complete ethid-mcp documentation with all 7 main sections
- All internal links updated and working
- Interactive examples functional
- Documentation builds without errors
- SEO metadata properly configured
- Cross-references to related EIK and EFP documentation
Related Links
- ETHID-MCP Repository
- Model Context Protocol Specification
- Claude Desktop MCP Documentation
- LLMS.txt Standard
This documentation addition will significantly improve the developer experience for users wanting to integrate Ethereum identity functionality into their AI-powered applications.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request