iflow-mcp-rust-docs 1.0.0

package/README.md

@@ -0,0 +1,101 @@
+# MCP Rust Documentation Server
+
+This is a Model Context Protocol (MCP) server that fetches and returns documentation for Rust crates providing essential context for LLM's when working with Rust code.
+
+## Features
+
+- Fetches documentation for any Rust crate available on docs.rs
+- Strips HTML and formats the content for readability
+- Limits response size to prevent overwhelming the client
+- Uses the latest MCP SDK (v1.6.1)
+
+## Installation
+
+```bash
+# Clone the repository
+git https://github.com/0xKoda/mcp-rust-docs.git
+cd mcp-rust-docs
+
+# Install dependencies
+npm install
+```
+
+### Prerequisites
+
+- Node.js 
+- npm 
+
+## Usage
+
+```bash
+# Start the server directly
+npm start
+```
+
+## Integrating with AI Assistants
+
+### Claude Desktop
+
+Add the following to your Claude Desktop configuration file (`claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "rust-docs": {
+      "command": "node",
+      "args": ["/absolute/path/to/index.js"]
+    }
+  }
+}
+```
+
+Replace `/absolute/path/to/index.js` with the absolute path to the index.js file in this repository.
+
+## Example Usage
+
+Once the server is running and configured with your AI assistant, you can ask questions like:
+
+- "Look up the documentation for the 'tokio' crate"
+- "What features does the 'serde' crate provide?"
+- "Show me the documentation for 'ratatui'"
+- "Can you explain the main modules in the 'axum' crate?"
+
+The AI will use the `lookup_crate_docs` tool to fetch and display the relevant documentation.
+
+## Testing with MCP Inspector
+
+You can test this server using the MCP Inspector:
+
+```bash
+npx @modelcontextprotocol/inspector
+```
+
+Then select the "Connect to a local server" option and follow the prompts.
+
+## How It Works
+
+This server implements a single MCP tool called `lookup_crate_docs` that:
+
+1. Takes a Rust crate name as input (optional, defaults to 'tokio' if not provided)
+2. Fetches the documentation from docs.rs
+3. Converts the HTML to plain text using the html-to-text library
+4. Truncates the content if it exceeds 8000 characters
+5. Returns the formatted documentation in the proper MCP response format
+
+## SDK Implementation Notes
+
+This server uses the MCP SDK with carefully structured import paths. If you're modifying the code, be aware that:
+
+1. The SDK requires importing from specific paths (e.g., `@modelcontextprotocol/sdk/server/mcp.js`)
+2. We use the high-level McpServer API rather than the low-level tools
+3. The tool definition uses Zod for parameter validation
+4. Console output is redirected to stderr to avoid breaking the MCP protocol
+5. The tool returns properly formatted MCP response objects
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,104 @@
+#!/usr/bin/env node
+// index.js - Plain JavaScript version
+const axios = require('axios');
+const { convert: htmlToText } = require('html-to-text');
+
+// Import specific modules from the SDK with corrected paths
+const { McpServer } = require('@modelcontextprotocol/sdk/server/mcp.js');
+const { StdioServerTransport } = require('@modelcontextprotocol/sdk/server/stdio.js');
+const { z } = require('zod');
+
+// Redirect console.log to stderr to avoid breaking the MCP protocol
+const originalConsoleLog = console.log;
+console.log = function() {
+  console.error.apply(console, arguments);
+};
+
+// Initialize the MCP server
+const server = new McpServer({
+  name: 'rust-docs',
+  version: '1.0.0'
+});
+
+// Define tool with proper Zod schema for parameters
+server.tool(
+  'lookup_crate_docs',
+  'Lookup documentation for a Rust crate from docs.rs',
+  { crateName: z.string().optional().describe('Name of the Rust crate to lookup documentation for') },
+  async (args) => {
+    try {
+      // Extract crateName from args or use default
+      const crateName = args.crateName || "tokio";
+      
+      console.error(`Fetching documentation for default crate: ${crateName}`);
+      
+      // Construct the docs.rs URL for the crate
+      const url = `https://docs.rs/${crateName}/latest/${crateName}/index.html`;
+      console.error(`Making request to: ${url}`);
+      
+      // Fetch the HTML content
+      const response = await axios.get(url);
+      console.error(`Received response with status: ${response.status}`);
+      
+      // Convert HTML to text
+      const text = htmlToText(response.data, {
+        wordwrap: 130,
+        selectors: [
+          { selector: 'a', options: { ignoreHref: true } },
+          { selector: 'img', format: 'skip' }
+        ]
+      });
+      
+      // Truncate if necessary
+      const maxLength = 8000;
+      const truncatedText = text.length > maxLength 
+        ? text.substring(0, maxLength) + `\n\n[Content truncated. Full documentation available at ${url}]` 
+        : text;
+      
+      console.error(`Successfully processed docs for ${crateName}`);
+      return {
+        content: [{ type: "text", text: truncatedText }]
+      };
+    } catch (error) {
+      console.error(`Error fetching documentation:`, error.message);
+      return {
+        content: [{ type: "text", text: `Error: Could not fetch documentation. ${error.message}` }],
+        isError: true
+      };
+    }
+  }
+);
+
+// Define prompts for tools
+server.prompt(
+  'lookup_crate_docs',
+  { crateName: z.string().describe('Name of the Rust crate to lookup documentation for') },
+  ({ crateName }) => ({
+    messages: [
+      {
+        role: "user",
+        content: {
+          type: "text",
+          text: `Please analyze and summarize the documentation for the Rust crate '${crateName}'. Focus on:
+1. The main purpose and features of the crate
+2. Key types and functions
+3. Common usage patterns
+4. Any important notes or warnings
+5. VERY IMPORTANT: Latest Version
+
+Documentation content will follow.`
+        }
+      }
+    ]
+  })
+);
+
+// Connect to the stdio transport and start the server
+server.connect(new StdioServerTransport())
+  .then(() => {
+    console.error('MCP Crate Docs Server is running...');
+  })
+  .catch((err) => {
+    console.error('Failed to start MCP server:', err);
+    process.exit(1);
+  });

package/language.json

@@ -0,0 +1 @@
+nodejs

package/package.json

@@ -0,0 +1 @@
+{"name": "iflow-mcp-rust-docs", "version": "1.0.0", "description": "MCP server for fetching Rust crate documentation", "main": "index.js", "bin": {"iflow-mcp-rust-docs": "index.js"}, "scripts": {"start": "node index.js", "build-ts": "tsc"}, "keywords": [], "author": "", "license": "MIT", "dependencies": {"@modelcontextprotocol/sdk": "^1.6.1", "axios": "^1.6.0", "html-to-text": "^9.0.5"}}

package/package_name

@@ -0,0 +1 @@
+@iflow-mcp/0xkoda-rust-docs

package/push_info.json

@@ -0,0 +1,5 @@
+{
+  "push_platform": "github",
+  "fork_url": "https://github.com/iflow-mcp/0xkoda-mcp-rust-docs",
+  "fork_branch": "iflow"
+}

package/server_config.json

@@ -0,0 +1 @@
+{"serverConfig": "{\"mcpServers\":{\"rust-docs\":{\"command\":\"npx\",\"args\":[\"-y\",\"@iflow-mcp/0xkoda-rust-docs\"],\"values\":{}}}}"}