diff --git a/README.md b/README.md index ce886ce..e648fb3 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,27 @@ It bridges the gap between AI and Anytype's powerful features by converting Anyt - Properties & Tags - Types & Templates -## Usage +## Quick Start -### 1. Configure in your MCP client +### 1. Get Your API Key + +1. Open Anytype +2. Go to Settings +3. Navigate to API Keys +4. Create a new API key + +
+Alternative: Get API key via CLI + +You can also get your API key using the command line: + +```bash +npx -y @anyproto/anytype-mcp get-key +``` + +
+ +### 2. Configure Your MCP Client Add the following configuration to your MCP client settings: @@ -32,21 +50,8 @@ Add the following configuration to your MCP client settings: } ``` -To get your Anytype API key, you can either: - -1. Use the command line: - -```bash -npx -y @anyproto/anytype-mcp get-key -``` - -2. Or get it from the Anytype desktop client: - - Open Anytype - - Go to Settings - - Navigate to API Keys - - Create a new API key - -### 2. Alternative: Global Installation +
+Alternative: Global Installation If you prefer to install the package globally: @@ -71,36 +76,6 @@ npm install -g @anyproto/anytype-mcp } ``` -
-Development: Installation from source - -If you need to install from source: - -1. Clone the repository: - -```bash -git clone https://github.com/anyproto/anytype-mcp.git -cd anytype-mcp -``` - -2. Install dependencies: - -```bash -npm install -D -``` - -3. Build the project: - -```bash -npm run build -``` - -4. Link the package globally: - -```bash -npm link -``` -
## Example Interactions @@ -114,6 +89,8 @@ Here are some examples of how you can interact with your Anytype: ## Development +### Installation from Source + 1. Clone the repository: ```bash @@ -133,6 +110,12 @@ npm install -D npm run build ``` +4. Link the package globally (optional): + +```bash +npm link +``` + ## Contribution Thank you for your desire to develop Anytype together! diff --git a/package-lock.json b/package-lock.json index a769b03..72ceec7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@anyproto/anytype-mcp", - "version": "1.0.0", + "version": "1.0.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@anyproto/anytype-mcp", - "version": "1.0.0", + "version": "1.0.1", "license": "MIT", "dependencies": { "@modelcontextprotocol/sdk": "^1.4.1", diff --git a/package.json b/package.json index a61d652..a533c00 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "mcp", "server" ], - "version": "1.0.1", + "version": "1.0.2", "license": "MIT", "type": "module", "scripts": { @@ -24,12 +24,6 @@ "bin": { "anytype-mcp": "bin/cli.mjs" }, - "exports": { - ".": { - "types": "./src/index.ts", - "import": "./src/index.ts" - } - }, "dependencies": { "@modelcontextprotocol/sdk": "^1.4.1", "axios": "^1.7.9", @@ -59,7 +53,16 @@ "typescript": "^5.7.3", "vitest": "^2.1.8" }, - "description": "OpenAPI Model Context Protocol Proxy", + "description": "Official MCP server for Anytype API", + "repository": { + "type": "git", + "url": "git@github.com:anyproto/anytype-mcp.git" + }, + "author": "@anyproto", + "bugs": { + "url": "https://github.com/anyproto/anytype-mcp/issues" + }, + "homepage": "https://github.com/anyproto/anytype-mcp#readme", "files": [ "bin", "dist",